Class CommonApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

CommonApi

Implements

ICommonApi

IApiAccessor

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Algorand.V2.Algod

Assembly: Algorand.dll

Syntax

public class CommonApi : ICommonApi, IApiAccessor

Constructors

| Improve this Doc View Source

CommonApi(Configuration)

Initializes a new instance of the CommonApi class using Configuration object

Declaration

public CommonApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

CommonApi(String)

Initializes a new instance of the CommonApi class.

Declaration

public CommonApi(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration

| Improve this Doc View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

| Improve this Doc View Source

AddDefaultHeader(String, String)

Add default header.

Declaration

[Obsolete("AddDefaultHeader is deprecated, please use Configuration.AddDefaultHeader instead.")]
public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

| Improve this Doc View Source

DefaultHeader()

Gets the default header.

Declaration

[Obsolete("DefaultHeader is deprecated, please use Configuration.DefaultHeader instead.")]
public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
System.Collections.Generic.IDictionary<System.String, System.String>	Dictionary of HTTP header

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

| Improve this Doc View Source

GetGenesis()

Gets the genesis information. Returns the entire genesis file in json.

Declaration

public string GetGenesis()

Returns

Type	Description
System.String	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetGenesisAsync()

Gets the genesis information. Returns the entire genesis file in json.

Declaration

public Task<string> GetGenesisAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetGenesisAsyncWithHttpInfo()

Gets the genesis information. Returns the entire genesis file in json.

Declaration

public Task<ApiResponse<string>> GetGenesisAsyncWithHttpInfo()

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<System.String>>	Task of ApiResponse (string)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetGenesisWithHttpInfo()

Gets the genesis information. Returns the entire genesis file in json.

Declaration

public ApiResponse<string> GetGenesisWithHttpInfo()

Returns

Type	Description
ApiResponse<System.String>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetVersion()

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

Declaration

public Version GetVersion()

Returns

Type	Description
Version	Version

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetVersionAsync()

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

Declaration

public Task<Version> GetVersionAsync()

Returns

Type	Description
System.Threading.Tasks.Task<Version>	Task of Version

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetVersionAsyncWithHttpInfo()

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

Declaration

public Task<ApiResponse<Version>> GetVersionAsyncWithHttpInfo()

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<Version>>	Task of ApiResponse (Version)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetVersionWithHttpInfo()

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

Declaration

public ApiResponse<Version> GetVersionWithHttpInfo()

Returns

Type	Description
ApiResponse<Version>	ApiResponse of Version

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

HealthCheck()

Returns OK if healthy.

Declaration

public void HealthCheck()

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

HealthCheckAsync()

Returns OK if healthy.

Declaration

public 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

public 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

public 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

public 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

public 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

public 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

public 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

SetBasePath(String)

Sets the base path of the API client.

Declaration

[Obsolete("SetBasePath is deprecated, please do 'Configuration.ApiClient = new ApiClient(\"http://new-path\")' instead.")]
public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

| Improve this Doc View Source

SwaggerJSON()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration

public string SwaggerJSON()

Returns

Type	Description
System.String	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

SwaggerJSONAsync()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration

public Task<string> SwaggerJSONAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

SwaggerJSONAsyncWithHttpInfo()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration

public Task<ApiResponse<string>> SwaggerJSONAsyncWithHttpInfo()

Returns

Type	Description
System.Threading.Tasks.Task<ApiResponse<System.String>>	Task of ApiResponse (string)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

SwaggerJSONWithHttpInfo()

Gets the current swagger spec. Returns the entire swagger spec in json.

Declaration

public ApiResponse<string> SwaggerJSONWithHttpInfo()

Returns

Type	Description
ApiResponse<System.String>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ICommonApi

IApiAccessor