Interface ICommonApi

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: Algorand.V2.Algod
Assembly: Algorand.dll
Syntax
public interface ICommonApi : IApiAccessor

Methods

| Improve this Doc View Source

GetGenesis()

Gets the genesis information.

Declaration
string GetGenesis()
Returns
Type Description
System.String

string
Remarks

Returns the entire genesis file in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetGenesisAsync()

Gets the genesis information.

Declaration
Task<string> GetGenesisAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Task of string
Remarks

Returns the entire genesis file in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetGenesisAsyncWithHttpInfo()

Gets the genesis information.

Declaration
Task<ApiResponse<string>> GetGenesisAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.String>>

Task of ApiResponse (string)
Remarks

Returns the entire genesis file in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetGenesisWithHttpInfo()

Gets the genesis information.

Declaration
ApiResponse<string> GetGenesisWithHttpInfo()
Returns
Type Description
ApiResponse<System.String>

ApiResponse of string
Remarks

Returns the entire genesis file in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersion()

Declaration
Version GetVersion()
Returns
Type Description
Version

Version
Remarks

Retrieves the supported API versions, binary build versions, and genesis information.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionAsync()

Declaration
Task<Version> GetVersionAsync()
Returns
Type Description
System.Threading.Tasks.Task<Version>

Task of Version
Remarks

Retrieves the supported API versions, binary build versions, and genesis information.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionAsyncWithHttpInfo()

Declaration
Task<ApiResponse<Version>> GetVersionAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<Version>>

Task of ApiResponse (Version)
Remarks

Retrieves the supported API versions, binary build versions, and genesis information.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

GetVersionWithHttpInfo()

Declaration
ApiResponse<Version> GetVersionWithHttpInfo()
Returns
Type Description
ApiResponse<Version>

ApiResponse of Version
Remarks

Retrieves the supported API versions, binary build versions, and genesis information.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheck()

Returns OK if healthy.

Declaration
void HealthCheck()
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckAsync()

Returns OK if healthy.

Declaration
Task HealthCheckAsync()
Returns
Type Description
System.Threading.Tasks.Task

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckAsyncWithHttpInfo()

Returns OK if healthy.

Declaration
Task<ApiResponse<object>> HealthCheckAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.Object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

HealthCheckWithHttpInfo()

Returns OK if healthy.

Declaration
ApiResponse<object> HealthCheckWithHttpInfo()
Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

Metrics()

Return metrics about algod functioning.

Declaration
void Metrics()
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsAsync()

Return metrics about algod functioning.

Declaration
Task MetricsAsync()
Returns
Type Description
System.Threading.Tasks.Task

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsAsyncWithHttpInfo()

Return metrics about algod functioning.

Declaration
Task<ApiResponse<object>> MetricsAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.Object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

MetricsWithHttpInfo()

Return metrics about algod functioning.

Declaration
ApiResponse<object> MetricsWithHttpInfo()
Returns
Type Description
ApiResponse<System.Object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSON()

Gets the current swagger spec.

Declaration
string SwaggerJSON()
Returns
Type Description
System.String

string
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONAsync()

Gets the current swagger spec.

Declaration
Task<string> SwaggerJSONAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Task of string
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONAsyncWithHttpInfo()

Gets the current swagger spec.

Declaration
Task<ApiResponse<string>> SwaggerJSONAsyncWithHttpInfo()
Returns
Type Description
System.Threading.Tasks.Task<ApiResponse<System.String>>

Task of ApiResponse (string)
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
| Improve this Doc View Source

SwaggerJSONWithHttpInfo()

Gets the current swagger spec.

Declaration
ApiResponse<string> SwaggerJSONWithHttpInfo()
Returns
Type Description
ApiResponse<System.String>

ApiResponse of string
Remarks

Returns the entire swagger spec in json.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call