Class OrganizationClient
Inheritance
Inherited Members
Namespace: Dangl.GiteaOrgManager.Client
Assembly: Dangl.GiteaOrgManager.dll
Syntax
public class OrganizationClient
Constructors
| Improve this Doc View SourceOrganizationClient(String, HttpClient)
Declaration
public OrganizationClient(string baseUrl, HttpClient httpClient)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | baseUrl | |
| System.Net.Http.HttpClient | httpClient |
Properties
| Improve this Doc View SourceBaseUrl
Declaration
public string BaseUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
JsonSerializerSettings
Declaration
protected Newtonsoft.Json.JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
| Type | Description |
|---|---|
| Newtonsoft.Json.JsonSerializerSettings |
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
| Improve this Doc View SourceCreateOrgRepoAsync(String, CreateRepoOption)
Create a repository in an organization
Declaration
public virtual Task<Repository> CreateOrgRepoAsync(string org, CreateRepoOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of organization |
| CreateRepoOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateOrgRepoAsync(String, CreateRepoOption, CancellationToken)
Create a repository in an organization
Declaration
public virtual async Task<Repository> CreateOrgRepoAsync(string org, CreateRepoOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of organization |
| CreateRepoOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateOrgRepoDeprecatedAsync(String, CreateRepoOption)
Create a repository in an organization
Declaration
[Obsolete]
public virtual Task<Repository> CreateOrgRepoDeprecatedAsync(string org, CreateRepoOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of organization |
| CreateRepoOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
CreateOrgRepoDeprecatedAsync(String, CreateRepoOption, CancellationToken)
Create a repository in an organization
Declaration
[Obsolete]
public virtual async Task<Repository> CreateOrgRepoDeprecatedAsync(string org, CreateRepoOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of organization |
| CreateRepoOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgAddTeamMemberAsync(Int64, String)
Add a team member
Declaration
public virtual Task OrgAddTeamMemberAsync(long id, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the user to add |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgAddTeamMemberAsync(Int64, String, CancellationToken)
Add a team member
Declaration
public virtual async Task OrgAddTeamMemberAsync(long id, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the user to add |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgAddTeamRepositoryAsync(Int64, String, String)
Add a repository to a team
Declaration
public virtual Task OrgAddTeamRepositoryAsync(long id, string org, string repo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to add |
| System.String | repo | name of the repo to add |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgAddTeamRepositoryAsync(Int64, String, String, CancellationToken)
Add a repository to a team
Declaration
public virtual async Task OrgAddTeamRepositoryAsync(long id, string org, string repo, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to add |
| System.String | repo | name of the repo to add |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgConcealMemberAsync(String, String)
Conceal a user's membership
Declaration
public virtual Task OrgConcealMemberAsync(string org, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgConcealMemberAsync(String, String, CancellationToken)
Conceal a user's membership
Declaration
public virtual async Task OrgConcealMemberAsync(string org, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateAsync(CreateOrgOption)
Create an organization
Declaration
public virtual Task<Organization> OrgCreateAsync(CreateOrgOption organization)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateOrgOption | organization |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateAsync(CreateOrgOption, CancellationToken)
Create an organization
Declaration
public virtual async Task<Organization> OrgCreateAsync(CreateOrgOption organization, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateOrgOption | organization | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateHookAsync(String, CreateHookOption)
Create a hook
Declaration
public virtual Task<Hook> OrgCreateHookAsync(string org, CreateHookOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateHookOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateHookAsync(String, CreateHookOption, CancellationToken)
Create a hook
Declaration
public virtual async Task<Hook> OrgCreateHookAsync(string org, CreateHookOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateHookOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateLabelAsync(String, CreateLabelOption)
Create a label for an organization
Declaration
public virtual Task<Label> OrgCreateLabelAsync(string org, CreateLabelOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateLabelOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateLabelAsync(String, CreateLabelOption, CancellationToken)
Create a label for an organization
Declaration
public virtual async Task<Label> OrgCreateLabelAsync(string org, CreateLabelOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateLabelOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateTeamAsync(String, CreateTeamOption)
Create a team
Declaration
public virtual Task<Team> OrgCreateTeamAsync(string org, CreateTeamOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateTeamOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgCreateTeamAsync(String, CreateTeamOption, CancellationToken)
Create a team
Declaration
public virtual async Task<Team> OrgCreateTeamAsync(string org, CreateTeamOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| CreateTeamOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteAsync(String)
Delete an organization
Declaration
public virtual Task OrgDeleteAsync(string org)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | organization that is to be deleted |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteAsync(String, CancellationToken)
Delete an organization
Declaration
public virtual async Task OrgDeleteAsync(string org, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | organization that is to be deleted |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteHookAsync(String, Int64)
Delete a hook
Declaration
public virtual Task OrgDeleteHookAsync(string org, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteHookAsync(String, Int64, CancellationToken)
Delete a hook
Declaration
public virtual async Task OrgDeleteHookAsync(string org, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteLabelAsync(String, Int64)
Delete a label
Declaration
public virtual Task OrgDeleteLabelAsync(string org, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteLabelAsync(String, Int64, CancellationToken)
Delete a label
Declaration
public virtual async Task OrgDeleteLabelAsync(string org, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteMemberAsync(String, String)
Remove a member from an organization
Declaration
public virtual Task OrgDeleteMemberAsync(string org, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | member removed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteMemberAsync(String, String, CancellationToken)
Remove a member from an organization
Declaration
public virtual async Task OrgDeleteMemberAsync(string org, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | member removed |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteTeamAsync(Int64)
Delete a team
Declaration
public virtual Task OrgDeleteTeamAsync(long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | team deleted |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgDeleteTeamAsync(Int64, CancellationToken)
Delete a team
Declaration
public virtual async Task OrgDeleteTeamAsync(long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team to delete |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | team deleted |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditAsync(String, EditOrgOption)
Edit an organization
Declaration
public virtual Task<Organization> OrgEditAsync(string org, EditOrgOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization to edit |
| EditOrgOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditAsync(String, EditOrgOption, CancellationToken)
Edit an organization
Declaration
public virtual async Task<Organization> OrgEditAsync(string org, EditOrgOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization to edit |
| EditOrgOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditHookAsync(String, Int64, EditHookOption)
Update a hook
Declaration
public virtual Task<Hook> OrgEditHookAsync(string org, long id, EditHookOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to update |
| EditHookOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditHookAsync(String, Int64, EditHookOption, CancellationToken)
Update a hook
Declaration
public virtual async Task<Hook> OrgEditHookAsync(string org, long id, EditHookOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to update |
| EditHookOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditLabelAsync(String, Int64, EditLabelOption)
Update a label
Declaration
public virtual Task<Label> OrgEditLabelAsync(string org, long id, EditLabelOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to edit |
| EditLabelOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditLabelAsync(String, Int64, EditLabelOption, CancellationToken)
Update a label
Declaration
public virtual async Task<Label> OrgEditLabelAsync(string org, long id, EditLabelOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to edit |
| EditLabelOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditTeamAsync(Int32, EditTeamOption)
Edit a team
Declaration
public virtual Task<Team> OrgEditTeamAsync(int id, EditTeamOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | id of the team to edit |
| EditTeamOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgEditTeamAsync(Int32, EditTeamOption, CancellationToken)
Edit a team
Declaration
public virtual async Task<Team> OrgEditTeamAsync(int id, EditTeamOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | id | id of the team to edit |
| EditTeamOption | body | |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetAllAsync(Nullable<Int32>, Nullable<Int32>)
Get list of organizations
Declaration
public virtual Task<ICollection<Organization>> OrgGetAllAsync(int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetAllAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
Get list of organizations
Declaration
public virtual async Task<ICollection<Organization>> OrgGetAllAsync(int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetAsync(String)
Get an organization
Declaration
public virtual Task<Organization> OrgGetAsync(string org)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetAsync(String, CancellationToken)
Get an organization
Declaration
public virtual async Task<Organization> OrgGetAsync(string org, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetHookAsync(String, Int64)
Get a hook
Declaration
public virtual Task<Hook> OrgGetHookAsync(string org, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetHookAsync(String, Int64, CancellationToken)
Get a hook
Declaration
public virtual async Task<Hook> OrgGetHookAsync(string org, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the hook to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetLabelAsync(String, Int64)
Get a single label
Declaration
public virtual Task<Label> OrgGetLabelAsync(string org, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetLabelAsync(String, Int64, CancellationToken)
Get a single label
Declaration
public virtual async Task<Label> OrgGetLabelAsync(string org, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Int64 | id | id of the label to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Label> | Label |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetTeamAsync(Int64)
Get a team
Declaration
public virtual Task<Team> OrgGetTeamAsync(long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team to get |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetTeamAsync(Int64, CancellationToken)
Get a team
Declaration
public virtual async Task<Team> OrgGetTeamAsync(long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team to get |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Team> | Team |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetUserPermissionsAsync(String, String)
Get user permissions in organization
Declaration
public virtual Task<OrganizationPermissions> OrgGetUserPermissionsAsync(string username, string org)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.String | org | name of the organization |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OrganizationPermissions> | OrganizationPermissions |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgGetUserPermissionsAsync(String, String, CancellationToken)
Get user permissions in organization
Declaration
public virtual async Task<OrganizationPermissions> OrgGetUserPermissionsAsync(string username, string org, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.String | org | name of the organization |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OrganizationPermissions> | OrganizationPermissions |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgIsMemberAsync(String, String)
Check if a user is a member of an organization
Declaration
public virtual Task OrgIsMemberAsync(string org, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | user is a member |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgIsMemberAsync(String, String, CancellationToken)
Check if a user is a member of an organization
Declaration
public virtual async Task OrgIsMemberAsync(string org, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | user is a member |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgIsPublicMemberAsync(String, String)
Check if a user is a public member of an organization
Declaration
public virtual Task OrgIsPublicMemberAsync(string org, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | user is a public member |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgIsPublicMemberAsync(String, String, CancellationToken)
Check if a user is a public member of an organization
Declaration
public virtual async Task OrgIsPublicMemberAsync(string org, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | user is a public member |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListActivityFeedsAsync(String, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)
List an organization's activity feeds
Declaration
public virtual Task<ICollection<Activity>> OrgListActivityFeedsAsync(string org, DateTimeOffset? date, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the org |
| System.Nullable<System.DateTimeOffset> | date | the date of the activities to be found |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Activity>> | ActivityFeedsList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListActivityFeedsAsync(String, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's activity feeds
Declaration
public virtual async Task<ICollection<Activity>> OrgListActivityFeedsAsync(string org, DateTimeOffset? date, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the org |
| System.Nullable<System.DateTimeOffset> | date | the date of the activities to be found |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Activity>> | ActivityFeedsList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListCurrentUserOrgsAsync(Nullable<Int32>, Nullable<Int32>)
List the current user's organizations
Declaration
public virtual Task<ICollection<Organization>> OrgListCurrentUserOrgsAsync(int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListCurrentUserOrgsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
List the current user's organizations
Declaration
public virtual async Task<ICollection<Organization>> OrgListCurrentUserOrgsAsync(int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListHooksAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's webhooks
Declaration
public virtual Task<ICollection<Hook>> OrgListHooksAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Hook>> | HookList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListHooksAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's webhooks
Declaration
public virtual async Task<ICollection<Hook>> OrgListHooksAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Hook>> | HookList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListLabelsAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's labels
Declaration
public virtual Task<ICollection<Label>> OrgListLabelsAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListLabelsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's labels
Declaration
public virtual async Task<ICollection<Label>> OrgListLabelsAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Label>> | LabelList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListMembersAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's members
Declaration
public virtual Task<ICollection<User>> OrgListMembersAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListMembersAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's members
Declaration
public virtual async Task<ICollection<User>> OrgListMembersAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListPublicMembersAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's public members
Declaration
public virtual Task<ICollection<User>> OrgListPublicMembersAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListPublicMembersAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's public members
Declaration
public virtual async Task<ICollection<User>> OrgListPublicMembersAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListReposAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's repos
Declaration
public virtual Task<ICollection<Repository>> OrgListReposAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>> | RepositoryList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListReposAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's repos
Declaration
public virtual async Task<ICollection<Repository>> OrgListReposAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>> | RepositoryList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamActivityFeedsAsync(Int64, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>)
List a team's activity feeds
Declaration
public virtual Task<ICollection<Activity>> OrgListTeamActivityFeedsAsync(long id, DateTimeOffset? date, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.DateTimeOffset> | date | the date of the activities to be found |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Activity>> | ActivityFeedsList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamActivityFeedsAsync(Int64, Nullable<DateTimeOffset>, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List a team's activity feeds
Declaration
public virtual async Task<ICollection<Activity>> OrgListTeamActivityFeedsAsync(long id, DateTimeOffset? date, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.DateTimeOffset> | date | the date of the activities to be found |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Activity>> | ActivityFeedsList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamMemberAsync(Int64, String)
List a particular member of team
Declaration
public virtual Task<User> OrgListTeamMemberAsync(long id, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the member to list |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamMemberAsync(Int64, String, CancellationToken)
List a particular member of team
Declaration
public virtual async Task<User> OrgListTeamMemberAsync(long id, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the member to list |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamMembersAsync(Int64, Nullable<Int32>, Nullable<Int32>)
List a team's members
Declaration
public virtual Task<ICollection<User>> OrgListTeamMembersAsync(long id, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamMembersAsync(Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List a team's members
Declaration
public virtual async Task<ICollection<User>> OrgListTeamMembersAsync(long id, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<User>> | UserList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamRepoAsync(Int64, String, String)
List a particular repo of team
Declaration
public virtual Task<Repository> OrgListTeamRepoAsync(long id, string org, string repo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to list |
| System.String | repo | name of the repo to list |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamRepoAsync(Int64, String, String, CancellationToken)
List a particular repo of team
Declaration
public virtual async Task<Repository> OrgListTeamRepoAsync(long id, string org, string repo, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to list |
| System.String | repo | name of the repo to list |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamReposAsync(Int64, Nullable<Int32>, Nullable<Int32>)
List a team's repos
Declaration
public virtual Task<ICollection<Repository>> OrgListTeamReposAsync(long id, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>> | RepositoryList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamReposAsync(Int64, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List a team's repos
Declaration
public virtual async Task<ICollection<Repository>> OrgListTeamReposAsync(long id, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Repository>> | RepositoryList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamsAsync(String, Nullable<Int32>, Nullable<Int32>)
List an organization's teams
Declaration
public virtual Task<ICollection<Team>> OrgListTeamsAsync(string org, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Team>> | TeamList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListTeamsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List an organization's teams
Declaration
public virtual async Task<ICollection<Team>> OrgListTeamsAsync(string org, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Team>> | TeamList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListUserOrgsAsync(String, Nullable<Int32>, Nullable<Int32>)
List a user's organizations
Declaration
public virtual Task<ICollection<Organization>> OrgListUserOrgsAsync(string username, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgListUserOrgsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
List a user's organizations
Declaration
public virtual async Task<ICollection<Organization>> OrgListUserOrgsAsync(string username, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<Organization>> | OrganizationList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgPublicizeMemberAsync(String, String)
Publicize a user's membership
Declaration
public virtual Task OrgPublicizeMemberAsync(string org, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | membership publicized |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgPublicizeMemberAsync(String, String, CancellationToken)
Publicize a user's membership
Declaration
public virtual async Task OrgPublicizeMemberAsync(string org, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | username | username of the user |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | membership publicized |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgRemoveTeamMemberAsync(Int64, String)
Remove a team member
Declaration
public virtual Task OrgRemoveTeamMemberAsync(long id, string username)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the user to remove |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgRemoveTeamMemberAsync(Int64, String, CancellationToken)
Remove a team member
Declaration
public virtual async Task OrgRemoveTeamMemberAsync(long id, string username, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | username | username of the user to remove |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgRemoveTeamRepositoryAsync(Int64, String, String)
Remove a repository from a team
Declaration
public virtual Task OrgRemoveTeamRepositoryAsync(long id, string org, string repo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to remove |
| System.String | repo | name of the repo to remove |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Remarks
This does not delete the repository, it only removes the repository from the team.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
OrgRemoveTeamRepositoryAsync(Int64, String, String, CancellationToken)
Remove a repository from a team
Declaration
public virtual async Task OrgRemoveTeamRepositoryAsync(long id, string org, string repo, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | id | id of the team |
| System.String | org | organization that owns the repo to remove |
| System.String | repo | name of the repo to remove |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Remarks
This does not delete the repository, it only removes the repository from the team.
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<OrganizationClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Net.Http.HttpResponseMessage | response | |
| System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> | headers | |
| System.Threading.CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OrganizationClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |
TeamSearchAsync(String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>)
Search for teams within an organization
Declaration
public virtual Task<Response> TeamSearchAsync(string org, string q, bool? include_desc, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | q | keywords to search |
| System.Nullable<System.Boolean> | include_desc | include search within team description (defaults to true) |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Response> | SearchResults of a successful search |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
TeamSearchAsync(String, String, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Search for teams within an organization
Declaration
public virtual async Task<Response> TeamSearchAsync(string org, string q, bool? include_desc, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | org | name of the organization |
| System.String | q | keywords to search |
| System.Nullable<System.Boolean> | include_desc | include search within team description (defaults to true) |
| System.Nullable<System.Int32> | page | page number of results to return (1-based) |
| System.Nullable<System.Int32> | limit | page size of results |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Response> | SearchResults of a successful search |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |