Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Seperate Pull-Request for md-based documentation #46

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Unity-Hyperion-API Client
layout: default
nav_order: 51
parent: Unity Game Development
has_children: true
lang-ref: Unity-Hyperion-API Client
lang: en
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
title: Classes

---

# Classes




* **namespace [HyperionApiClient](/Namespaces/namespace_hyperion_api_client.md)**
* **namespace [Clients](/Namespaces/namespace_hyperion_api_client_1_1_clients.md)**
* **class [AccountsClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md)**
* **class [ChainClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_chain_client.md)**
* **class [HistoryClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_history_client.md)**
* **class [StatsClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_stats_client.md)**
* **class [StatusClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_status_client.md)**
* **namespace [Models](/Namespaces/namespace_hyperion_api_client_1_1_models.md)**
* **class [Abi](/Classes/class_hyperion_api_client_1_1_models_1_1_abi.md)**
* **class [Account](/Classes/class_hyperion_api_client_1_1_models_1_1_account.md)**
* **class [Account2](/Classes/class_hyperion_api_client_1_1_models_1_1_account2.md)**
* **class [AccountRamDelta](/Classes/class_hyperion_api_client_1_1_models_1_1_account_ram_delta.md)**
* **class [Act](/Classes/class_hyperion_api_client_1_1_models_1_1_act.md)**
* **class [Action](/Classes/class_hyperion_api_client_1_1_models_1_1_action.md)**
* **class [Action2](/Classes/class_hyperion_api_client_1_1_models_1_1_action2.md)**
* **class [Action3](/Classes/class_hyperion_api_client_1_1_models_1_1_action3.md)**
* **class [Action4](/Classes/class_hyperion_api_client_1_1_models_1_1_action4.md)**
* **class [Action5](/Classes/class_hyperion_api_client_1_1_models_1_1_action5.md)**
* **class [Action6](/Classes/class_hyperion_api_client_1_1_models_1_1_action6.md)**
* **class [Action7](/Classes/class_hyperion_api_client_1_1_models_1_1_action7.md)**
* **class [ActionTrace](/Classes/class_hyperion_api_client_1_1_models_1_1_action_trace.md)**
* **class [ActivatedProtocolFeature](/Classes/class_hyperion_api_client_1_1_models_1_1_activated_protocol_feature.md)**
* **class [ActivatedProtocolFeatures](/Classes/class_hyperion_api_client_1_1_models_1_1_activated_protocol_features.md)**
* **class [ActiveSchedule](/Classes/class_hyperion_api_client_1_1_models_1_1_active_schedule.md)**
* **class [ApiException](/Classes/class_hyperion_api_client_1_1_models_1_1_api_exception.md)**
* **class [AuthSequence](/Classes/class_hyperion_api_client_1_1_models_1_1_auth_sequence.md)**
* **class [Authorization](/Classes/class_hyperion_api_client_1_1_models_1_1_authorization.md)**
* **class [Authorization2](/Classes/class_hyperion_api_client_1_1_models_1_1_authorization2.md)**
* **class [BlockrootMerkle](/Classes/class_hyperion_api_client_1_1_models_1_1_blockroot_merkle.md)**
* **class [Body](/Classes/class_hyperion_api_client_1_1_models_1_1_body.md)**
* **class [ClientExtensions](/Classes/class_hyperion_api_client_1_1_models_1_1_client_extensions.md)**
* **struct [ObjectResponseResult](/Classes/struct_hyperion_api_client_1_1_models_1_1_client_extensions_1_1_object_response_result.md)**
* **class [Cpu](/Classes/class_hyperion_api_client_1_1_models_1_1_cpu.md)**
* **class [CpuLimit](/Classes/class_hyperion_api_client_1_1_models_1_1_cpu_limit.md)**
* **class [Data](/Classes/class_hyperion_api_client_1_1_models_1_1_data.md)**
* **class [Delta](/Classes/class_hyperion_api_client_1_1_models_1_1_delta.md)**
* **class [Event](/Classes/class_hyperion_api_client_1_1_models_1_1_event.md)**
* **class [ExtendedAct](/Classes/class_hyperion_api_client_1_1_models_1_1_extended_act.md)**
* **class [ExtendedLink](/Classes/class_hyperion_api_client_1_1_models_1_1_extended_link.md)**
* **class [Features](/Classes/class_hyperion_api_client_1_1_models_1_1_features.md)**
* **class [Field](/Classes/class_hyperion_api_client_1_1_models_1_1_field.md)**
* **class [GetAbiResponse](/Classes/class_hyperion_api_client_1_1_models_1_1_get_abi_response.md)**
* **class [Header](/Classes/class_hyperion_api_client_1_1_models_1_1_header.md)**
* **class [Health](/Classes/class_hyperion_api_client_1_1_models_1_1_health.md)**
* **class [Link](/Classes/class_hyperion_api_client_1_1_models_1_1_link.md)**
* **class [Net](/Classes/class_hyperion_api_client_1_1_models_1_1_net.md)**
* **class [NetLimit](/Classes/class_hyperion_api_client_1_1_models_1_1_net_limit.md)**
* **class [PendingSchedule](/Classes/class_hyperion_api_client_1_1_models_1_1_pending_schedule.md)**
* **class [Percentiles](/Classes/class_hyperion_api_client_1_1_models_1_1_percentiles.md)**
* **class [Permission](/Classes/class_hyperion_api_client_1_1_models_1_1_permission.md)**
* **class [Permission2](/Classes/class_hyperion_api_client_1_1_models_1_1_permission2.md)**
* **class [Producer](/Classes/class_hyperion_api_client_1_1_models_1_1_producer.md)**
* **class [Producer2](/Classes/class_hyperion_api_client_1_1_models_1_1_producer2.md)**
* **class [ProducerRow](/Classes/class_hyperion_api_client_1_1_models_1_1_producer_row.md)**
* **class [Proposal](/Classes/class_hyperion_api_client_1_1_models_1_1_proposal.md)**
* **class [ProvidedApproval](/Classes/class_hyperion_api_client_1_1_models_1_1_provided_approval.md)**
* **class [Receipt](/Classes/class_hyperion_api_client_1_1_models_1_1_receipt.md)**
* **class [RequestedApproval](/Classes/class_hyperion_api_client_1_1_models_1_1_requested_approval.md)**
* **class [RequiredAuth](/Classes/class_hyperion_api_client_1_1_models_1_1_required_auth.md)**
* **class [RicardianClaus](/Classes/class_hyperion_api_client_1_1_models_1_1_ricardian_claus.md)**
* **class [Schedule](/Classes/class_hyperion_api_client_1_1_models_1_1_schedule.md)**
* **class [ServiceData](/Classes/class_hyperion_api_client_1_1_models_1_1_service_data.md)**
* **class [SimpleAction](/Classes/class_hyperion_api_client_1_1_models_1_1_simple_action.md)**
* **class [Specification](/Classes/class_hyperion_api_client_1_1_models_1_1_specification.md)**
* **class [Stats](/Classes/class_hyperion_api_client_1_1_models_1_1_stats.md)**
* **class [StdDeviationBounds](/Classes/class_hyperion_api_client_1_1_models_1_1_std_deviation_bounds.md)**
* **class [Streaming](/Classes/class_hyperion_api_client_1_1_models_1_1_streaming.md)**
* **class [Struct](/Classes/class_hyperion_api_client_1_1_models_1_1_struct.md)**
* **class [SubjectiveCpuBillLimit](/Classes/class_hyperion_api_client_1_1_models_1_1_subjective_cpu_bill_limit.md)**
* **class [Table](/Classes/class_hyperion_api_client_1_1_models_1_1_table.md)**
* **class [TableByScopeRow](/Classes/class_hyperion_api_client_1_1_models_1_1_table_by_scope_row.md)**
* **class [Tables](/Classes/class_hyperion_api_client_1_1_models_1_1_tables.md)**
* **class [Token](/Classes/class_hyperion_api_client_1_1_models_1_1_token.md)**
* **class [Total](/Classes/class_hyperion_api_client_1_1_models_1_1_total.md)**
* **class [TotalResources](/Classes/class_hyperion_api_client_1_1_models_1_1_total_resources.md)**
* **class [Transaction](/Classes/class_hyperion_api_client_1_1_models_1_1_transaction.md)**
* **class [Transaction2](/Classes/class_hyperion_api_client_1_1_models_1_1_transaction2.md)**
* **class [Transaction3](/Classes/class_hyperion_api_client_1_1_models_1_1_transaction3.md)**
* **class [Trx](/Classes/class_hyperion_api_client_1_1_models_1_1_trx.md)**
* **class [Voter](/Classes/class_hyperion_api_client_1_1_models_1_1_voter.md)**
* **class [VoterInfo](/Classes/class_hyperion_api_client_1_1_models_1_1_voter_info.md)**
* **namespace [Responses](/Namespaces/namespace_hyperion_api_client_1_1_responses.md)**
* **class [GetAccountResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_account_response.md)**
* **class [GetAccountResponse2](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_account_response2.md)**
* **class [GetActionUsageResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_action_usage_response.md)**
* **class [GetActionsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_actions_response.md)**
* **class [GetActionsResponse2](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_actions_response2.md)**
* **class [GetActivatedProtocolFeaturesBody](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_activated_protocol_features_body.md)**
* **class [GetActivatedProtocolFeaturesResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_activated_protocol_features_response.md)**
* **class [GetApiSnapshotResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_api_snapshot_response.md)**
* **class [GetBlockHeaderStateResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_block_header_state_response.md)**
* **class [GetBlockResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_block_response.md)**
* **class [GetBlockResponse2](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_block_response2.md)**
* **class [GetCodeResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_code_response.md)**
* **class [GetControlledAccountsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_controlled_accounts_response.md)**
* **class [GetCreatedAccountsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_created_accounts_response.md)**
* **class [GetCreatorResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_creator_response.md)**
* **class [GetDeltasResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_deltas_response.md)**
* **class [GetHealthResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_health_response.md)**
* **class [GetInfoResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_info_response.md)**
* **class [GetKeyAccountsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_key_accounts_response.md)**
* **class [GetKeyAccountsWithPermissionsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_key_accounts_with_permissions_response.md)**
* **class [GetLinksResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_links_response.md)**
* **class [GetMissedBlocksResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_missed_blocks_response.md)**
* **class [GetProducersResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_producers_response.md)**
* **class [GetProposalsResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_proposals_response.md)**
* **class [GetResourceUsageResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_resource_usage_response.md)**
* **class [GetScheduleResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_schedule_response.md)**
* **class [GetTableByScopeResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_table_by_scope_response.md)**
* **class [GetTokensResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_tokens_response.md)**
* **class [GetTransactionResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_transaction_response.md)**
* **class [GetVotersResponse](/Classes/class_hyperion_api_client_1_1_responses_1_1_get_voters_response.md)**



-------------------------------

Updated on 2022-05-31 at 20:04:45 +0000
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
---
title: HyperionApiClient::Clients::AccountsClient

---

# HyperionApiClient::Clients::AccountsClient





Inherits from ClientExtensions

## Public Functions

| | Name |
| -------------- | -------------- |
| | **[AccountsClient](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-accountsclient)**(HttpClient httpClient) |
| async Task< GetCreatedAccountsResponse > | **[GetCreatedAccountsAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getcreatedaccountsasync)**(string account, int? limit =null, int? skip =null, CancellationToken cancellationToken =default) =default<br>get created accounts |
| async Task< GetCreatorResponse > | **[GetCreatorAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getcreatorasync)**(string account, CancellationToken cancellationToken =default) =default<br>get account creator |
| async Task< GetAccountResponse > | **[GetAccountAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getaccountasync)**(string account, int? limit =null, int? skip =null, CancellationToken cancellationToken =default) =default<br>get account summary |
| async Task< GetKeyAccountsWithPermissionsResponse > | **[GetKeyAccountsAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getkeyaccountsasync)**(string publicKey, int? limit =null, int? skip =null, bool? details =null, CancellationToken cancellationToken =default) =default<br>get accounts by public key |
| async Task< GetLinksResponse > | **[GetLinksAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getlinksasync)**(string account =null, string code =null, string action =null, string permission =null, CancellationToken cancellationToken =default) =default<br>get permission links |
| async Task< GetTokensResponse > | **[GetTokensAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-gettokensasync)**(string account, int? limit =null, int? skip =null, CancellationToken cancellationToken =default) =default<br>get all tokens |
| async Task< GetControlledAccountsResponse > | **[GetControlledAccountsAsync](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#function-getcontrolledaccountsasync)**(string controllingAccount, CancellationToken cancellationToken =default) =default<br>get controlled accounts by controlling accounts |

## Public Properties

| | Name |
| -------------- | -------------- |
| string | **[BaseUrl](/Classes/class_hyperion_api_client_1_1_clients_1_1_accounts_client.md#property-baseurl)** |

## Public Functions Documentation

### function AccountsClient

```csharp
AccountsClient(
HttpClient httpClient
)
```


### function GetCreatedAccountsAsync

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

get created accounts

**Parameters**:

* **cancellationToken** A cancellation token that can be used by other objects or threads to receive notice of cancellation.
* **account** creator account
* **limit** limit of [n] results per page
* **skip** skip [n] results


**Exceptions**:

* **ApiException** A server side error occurred.


### function GetCreatorAsync

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

get account creator

**Parameters**:

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


**Exceptions**:

* **ApiException** A server side error occurred.


### function GetAccountAsync

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

get account summary

**Parameters**:

* **cancellationToken** A cancellation token that can be used by other objects or threads to receive notice of cancellation.
* **account** account name
* **limit** limit of [n] results per page
* **skip** skip [n] results


**Exceptions**:

* **ApiException** A server side error occurred.


### function GetKeyAccountsAsync

```csharp
async Task< GetKeyAccountsWithPermissionsResponse > GetKeyAccountsAsync(
string publicKey,
int? limit =null,
int? skip =null,
bool? details =null,
CancellationToken cancellationToken =default
) =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.
* **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.


### function GetLinksAsync

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

get permission links

**Parameters**:

* **cancellationToken** A cancellation token that can be used by other objects or threads to receive notice of cancellation.
* **account** account name
* **code** contract name
* **action** method name
* **permission** permission name


**Exceptions**:

* **ApiException** A server side error occurred.


### function GetTokensAsync

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

get all tokens

**Parameters**:

* **cancellationToken** A cancellation token that can be used by other objects or threads to receive notice of cancellation.
* **account** account name
* **limit** limit of [n] results per page
* **skip** skip [n] results


**Exceptions**:

* **ApiException** A server side error occurred.


**Return**: Default Response

### function GetControlledAccountsAsync

```csharp
async Task< GetControlledAccountsResponse > GetControlledAccountsAsync(
string controllingAccount,
CancellationToken cancellationToken =default
) =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.


## Public Property Documentation

### property BaseUrl

```csharp
string BaseUrl = "https://api.wax.liquidstudios.io/";
```


-------------------------------

Updated on 2022-05-31 at 20:04:45 +0000
Loading