AccountsClient

class HyperionApiClient::Clients::AccountsClient
  : public ClientExtensions

Summary

Members	Descriptions
public string BaseUrl
public AccountsClient(HttpClient httpClient)
public async Task< GetCreatedAccountsResponse > GetCreatedAccountsAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default	get created accounts
public async Task< GetCreatorResponse > GetCreatorAsync(string account, CancellationToken cancellationToken) = default	get account creator
public async Task< GetAccountResponse > GetAccountAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default	get account summary
public async Task< GetKeyAccountsWithPermissionsResponse > GetKeyAccountsAsync(string publicKey, int? limit, int? skip, bool? details, CancellationToken cancellationToken) = default	get accounts by public key
public async Task< GetLinksResponse > GetLinksAsync(string account, string code, string action, string permission, CancellationToken cancellationToken) = default	get permission links
public async Task< GetTokensResponse > GetTokensAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default	get all tokens
public async Task< GetControlledAccountsResponse > GetControlledAccountsAsync(string controllingAccount, CancellationToken cancellationToken) = default	get controlled accounts by controlling accounts
private readonly HttpClient _httpClient

Members

public string BaseUrl

public AccountsClient(HttpClient httpClient)

public async Task< GetCreatedAccountsResponse > GetCreatedAccountsAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default

get created accounts

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• account creator account

• limit limit of [n] results per page

• skip skip [n] results

Exceptions

• ApiException A server side error occurred.

public async Task< GetCreatorResponse > GetCreatorAsync(string account, CancellationToken cancellationToken) = default

get account creator

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• account created account

Exceptions

• ApiException A server side error occurred.

public async Task< GetAccountResponse > GetAccountAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default

get account summary

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• account account name

• limit limit of [n] results per page

• skip skip [n] results

Exceptions

• ApiException A server side error occurred.

public async Task< GetKeyAccountsWithPermissionsResponse > GetKeyAccountsAsync(string publicKey, int? limit, int? skip, bool? details, CancellationToken cancellationToken) = default

get accounts by public key

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• public_key public key

• limit limit of [n] results per page

• skip skip [n] results

• details include permission details

Exceptions

• ApiException A server side error occurred.

public async Task< GetLinksResponse > GetLinksAsync(string account, string code, string action, string permission, CancellationToken cancellationToken) = default

get permission links

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• account account name

• code contract name

• action method name

• permission permission name

Exceptions

• ApiException A server side error occurred.

public async Task< GetTokensResponse > GetTokensAsync(string account, int? limit, int? skip, CancellationToken cancellationToken) = default

get all tokens

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Parameters

• account account name

• limit limit of [n] results per page

• skip skip [n] results

Returns

Default Response

Exceptions

• ApiException A server side error occurred.

public async Task< GetControlledAccountsResponse > GetControlledAccountsAsync(string controllingAccount, CancellationToken cancellationToken) = default

get controlled accounts by controlling accounts

Parameters

• cancellationToken A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

• ApiException A server side error occurred.

private readonly HttpClient _httpClient