Class AdminClient
Inheritance
Inherited Members
Namespace: Dangl.GiteaOrgManager.Client
Assembly: Dangl.GiteaOrgManager.dll
Syntax
public class AdminClient
Constructors
| Improve this Doc View SourceAdminClient(String, HttpClient)
Declaration
public AdminClient(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 SourceAdminAdoptRepositoryAsync(String, String)
Adopt unadopted files as a repository
Declaration
public virtual Task AdminAdoptRepositoryAsync(string owner, string repo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminAdoptRepositoryAsync(String, String, CancellationToken)
Adopt unadopted files as a repository
Declaration
public virtual async Task AdminAdoptRepositoryAsync(string owner, string repo, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| 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. |
AdminCreateHookAsync(CreateHookOption)
Create a hook
Declaration
public virtual Task<Hook> AdminCreateHookAsync(CreateHookOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateHookOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Hook> | Hook |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreateHookAsync(CreateHookOption, CancellationToken)
Create a hook
Declaration
public virtual async Task<Hook> AdminCreateHookAsync(CreateHookOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminCreateOrgAsync(String, CreateOrgOption)
Create an organization
Declaration
public virtual Task<Organization> AdminCreateOrgAsync(string username, CreateOrgOption organization)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user that will own the created organization |
| CreateOrgOption | organization |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Organization> | Organization |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreateOrgAsync(String, CreateOrgOption, CancellationToken)
Create an organization
Declaration
public virtual async Task<Organization> AdminCreateOrgAsync(string username, CreateOrgOption organization, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user that will own the created organization |
| 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. |
AdminCreatePublicKeyAsync(String, CreateKeyOption)
Add a public key on behalf of a user
Declaration
public virtual Task<PublicKey> AdminCreatePublicKeyAsync(string username, CreateKeyOption key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user |
| CreateKeyOption | key |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<PublicKey> | PublicKey |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreatePublicKeyAsync(String, CreateKeyOption, CancellationToken)
Add a public key on behalf of a user
Declaration
public virtual async Task<PublicKey> AdminCreatePublicKeyAsync(string username, CreateKeyOption key, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user |
| CreateKeyOption | key | |
| 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<PublicKey> | PublicKey |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreateRepoAsync(String, CreateRepoOption)
Create a repository on behalf of a user
Declaration
public virtual Task<Repository> AdminCreateRepoAsync(string username, CreateRepoOption repository)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user. This user will own the created repository |
| CreateRepoOption | repository |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<Repository> | Repository |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreateRepoAsync(String, CreateRepoOption, CancellationToken)
Create a repository on behalf of a user
Declaration
public virtual async Task<Repository> AdminCreateRepoAsync(string username, CreateRepoOption repository, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of the user. This user will own the created repository |
| CreateRepoOption | repository | |
| 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. |
AdminCreateUserAsync(CreateUserOption)
Create a user
Declaration
public virtual Task<User> AdminCreateUserAsync(CreateUserOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCreateUserAsync(CreateUserOption, CancellationToken)
Create a user
Declaration
public virtual async Task<User> AdminCreateUserAsync(CreateUserOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateUserOption | 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<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCronListAsync(Nullable<Int32>, Nullable<Int32>)
List cron tasks
Declaration
public virtual Task<ICollection<Cron>> AdminCronListAsync(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<Cron>> | CronList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCronListAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
List cron tasks
Declaration
public virtual async Task<ICollection<Cron>> AdminCronListAsync(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<Cron>> | CronList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCronRunAsync(String)
Run cron task
Declaration
public virtual Task AdminCronRunAsync(string task)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | task | task to run |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminCronRunAsync(String, CancellationToken)
Run cron task
Declaration
public virtual async Task AdminCronRunAsync(string task, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | task | task to run |
| 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. |
AdminDeleteHookAsync(Int64)
Delete a hook
Declaration
public virtual Task AdminDeleteHookAsync(long id)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminDeleteHookAsync(Int64, CancellationToken)
Delete a hook
Declaration
public virtual async Task AdminDeleteHookAsync(long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminDeleteUnadoptedRepositoryAsync(String, String)
Delete unadopted files
Declaration
public virtual Task AdminDeleteUnadoptedRepositoryAsync(string owner, string repo)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminDeleteUnadoptedRepositoryAsync(String, String, CancellationToken)
Delete unadopted files
Declaration
public virtual async Task AdminDeleteUnadoptedRepositoryAsync(string owner, string repo, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | owner | owner of the repo |
| System.String | repo | name of the repo |
| 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. |
AdminDeleteUserAsync(String, Nullable<Boolean>)
Delete a user
Declaration
public virtual Task AdminDeleteUserAsync(string username, bool? purge)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user to delete |
| System.Nullable<System.Boolean> | purge | purge the user from the system completely |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminDeleteUserAsync(String, Nullable<Boolean>, CancellationToken)
Delete a user
Declaration
public virtual async Task AdminDeleteUserAsync(string username, bool? purge, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user to delete |
| System.Nullable<System.Boolean> | purge | purge the user from the system completely |
| 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. |
AdminDeleteUserPublicKeyAsync(String, Int64)
Delete a user's public key
Declaration
public virtual Task AdminDeleteUserPublicKeyAsync(string username, long id)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.Int64 | id | id of the key to delete |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminDeleteUserPublicKeyAsync(String, Int64, CancellationToken)
Delete a user's public key
Declaration
public virtual async Task AdminDeleteUserPublicKeyAsync(string username, long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user |
| System.Int64 | id | id of the key 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. |
AdminEditHookAsync(Int64, EditHookOption)
Update a hook
Declaration
public virtual Task<Hook> AdminEditHookAsync(long id, EditHookOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminEditHookAsync(Int64, EditHookOption, CancellationToken)
Update a hook
Declaration
public virtual async Task<Hook> AdminEditHookAsync(long id, EditHookOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminEditUserAsync(String, EditUserOption)
Edit an existing user
Declaration
public virtual Task<User> AdminEditUserAsync(string username, EditUserOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user to edit |
| EditUserOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminEditUserAsync(String, EditUserOption, CancellationToken)
Edit an existing user
Declaration
public virtual async Task<User> AdminEditUserAsync(string username, EditUserOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | username of user to edit |
| EditUserOption | 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<User> | User |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminGetAllEmailsAsync(Nullable<Int32>, Nullable<Int32>)
List all emails
Declaration
public virtual Task<ICollection<Email>> AdminGetAllEmailsAsync(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<Email>> | EmailList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminGetAllEmailsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all emails
Declaration
public virtual async Task<ICollection<Email>> AdminGetAllEmailsAsync(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<Email>> | EmailList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminGetAllOrgsAsync(Nullable<Int32>, Nullable<Int32>)
List all organizations
Declaration
public virtual Task<ICollection<Organization>> AdminGetAllOrgsAsync(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. |
AdminGetAllOrgsAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
List all organizations
Declaration
public virtual async Task<ICollection<Organization>> AdminGetAllOrgsAsync(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. |
AdminGetHookAsync(Int64)
Get a hook
Declaration
public virtual Task<Hook> AdminGetHookAsync(long id)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminGetHookAsync(Int64, CancellationToken)
Get a hook
Declaration
public virtual async Task<Hook> AdminGetHookAsync(long id, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| 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. |
AdminListHooksAsync(Nullable<Int32>, Nullable<Int32>)
List system's webhooks
Declaration
public virtual Task<ICollection<Hook>> AdminListHooksAsync(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<Hook>> | HookList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminListHooksAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)
List system's webhooks
Declaration
public virtual async Task<ICollection<Hook>> AdminListHooksAsync(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<Hook>> | HookList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminRenameUserAsync(String, RenameUserOption)
Rename a user
Declaration
public virtual Task AdminRenameUserAsync(string username, RenameUserOption body)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | existing username of user |
| RenameUserOption | body |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminRenameUserAsync(String, RenameUserOption, CancellationToken)
Rename a user
Declaration
public virtual async Task AdminRenameUserAsync(string username, RenameUserOption body, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | username | existing username of user |
| RenameUserOption | 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 | APIEmpty is an empty response |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminSearchEmailsAsync(String, Nullable<Int32>, Nullable<Int32>)
Search all emails
Declaration
public virtual Task<ICollection<Email>> AdminSearchEmailsAsync(string q, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | q | keyword |
| 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<Email>> | EmailList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminSearchEmailsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Search all emails
Declaration
public virtual async Task<ICollection<Email>> AdminSearchEmailsAsync(string q, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | q | keyword |
| 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<Email>> | EmailList |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminSearchUsersAsync(Nullable<Int64>, String, Nullable<Int32>, Nullable<Int32>)
Search users according filter conditions
Declaration
public virtual Task<ICollection<User>> AdminSearchUsersAsync(long? source_id, string login_name, int? page, int? limit)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | source_id | ID of the user's login source to search for |
| System.String | login_name | user's login name to search for |
| 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. |
AdminSearchUsersAsync(Nullable<Int64>, String, Nullable<Int32>, Nullable<Int32>, CancellationToken)
Search users according filter conditions
Declaration
public virtual async Task<ICollection<User>> AdminSearchUsersAsync(long? source_id, string login_name, int? page, int? limit, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Int64> | source_id | ID of the user's login source to search for |
| System.String | login_name | user's login name to search for |
| 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. |
AdminUnadoptedListAsync(Nullable<Int32>, Nullable<Int32>, String)
List unadopted repositories
Declaration
public virtual Task<ICollection<string>> AdminUnadoptedListAsync(int? page, int? limit, string pattern)
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.String | pattern | pattern of repositories to search for |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.ICollection<System.String>> | StringSlice |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
AdminUnadoptedListAsync(Nullable<Int32>, Nullable<Int32>, String, CancellationToken)
List unadopted repositories
Declaration
public virtual async Task<ICollection<string>> AdminUnadoptedListAsync(int? page, int? limit, string pattern, 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.String | pattern | pattern of repositories to search for |
| 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<System.String>> | StringSlice |
Exceptions
| Type | Condition |
|---|---|
| ApiException | A server side error occurred. |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<AdminClient.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<AdminClient.ObjectResponseResult<T>> |
Type Parameters
| Name | Description |
|---|---|
| T |