Class PrivateApi

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

PrivateApi

Implements

IPrivateApi

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 PrivateApi : IPrivateApi, IApiAccessor

Constructors

| Improve this Doc View Source

PrivateApi(Configuration)

Initializes a new instance of the PrivateApi class using Configuration object

Declaration

public PrivateApi(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

PrivateApi(String)

Initializes a new instance of the PrivateApi class.

Declaration

public PrivateApi(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

AbortCatchup(String)

Aborts a catchpoint catchup. Given a catchpoint, it aborts catching up to this catchpoint

Declaration

public CatchpointAbortResponse AbortCatchup(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
CatchpointAbortResponse	CatchpointAbortResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupAsync(String)

Aborts a catchpoint catchup. Given a catchpoint, it aborts catching up to this catchpoint

Declaration

public Task<CatchpointAbortResponse> AbortCatchupAsync(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupAsyncWithHttpInfo(String)

Aborts a catchpoint catchup. Given a catchpoint, it aborts catching up to this catchpoint

Declaration

public Task<ApiResponse<CatchpointAbortResponse>> AbortCatchupAsyncWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

AbortCatchupWithHttpInfo(String)

Aborts a catchpoint catchup. Given a catchpoint, it aborts catching up to this catchpoint

Declaration

public ApiResponse<CatchpointAbortResponse> AbortCatchupWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
ApiResponse<CatchpointAbortResponse>	ApiResponse of CatchpointAbortResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| 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

RegisterParticipationKeys(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Generate (or renew) and register participation keys on the node for a given account address.

Declaration

public PostTransactionsResponse RegisterParticipationKeys(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
PostTransactionsResponse	PostTransactionsResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysAsync(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Generate (or renew) and register participation keys on the node for a given account address.

Declaration

public Task<PostTransactionsResponse> RegisterParticipationKeysAsync(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysAsyncWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Generate (or renew) and register participation keys on the node for a given account address.

Declaration

public Task<ApiResponse<PostTransactionsResponse>> RegisterParticipationKeysAsyncWithHttpInfo(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

RegisterParticipationKeysWithHttpInfo(String, Nullable<Int64>, Nullable<Int64>, Nullable<Int64>, Nullable<Boolean>)

Generate (or renew) and register participation keys on the node for a given account address.

Declaration

public ApiResponse<PostTransactionsResponse> RegisterParticipationKeysWithHttpInfo(string address, long? fee = default(long? ), long? keyDilution = default(long? ), long? roundLastValid = default(long? ), bool? noWait = default(bool? ))

Parameters

Type	Name	Description
System.String	address	The `account-id` to update, or `all` to update all accounts.
System.Nullable<System.Int64>	fee	The fee to use when submitting key registration transactions. Defaults to the suggested fee. (optional, default to 1000)
System.Nullable<System.Int64>	keyDilution	value to use for two-level participation key. (optional)
System.Nullable<System.Int64>	roundLastValid	The last round for which the generated participation keys will be valid. (optional)
System.Nullable<System.Boolean>	noWait	Don't wait for transaction to commit before returning response. (optional)

Returns

Type	Description
ApiResponse<PostTransactionsResponse>	ApiResponse of PostTransactionsResponse

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

ShutdownNode(Nullable<Int32>)

Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.

Declaration

public object ShutdownNode(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
System.Object	Object

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeAsync(Nullable<Int32>)

Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.

Declaration

public Task<object> ShutdownNodeAsync(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeAsyncWithHttpInfo(Nullable<Int32>)

Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.

Declaration

public Task<ApiResponse<object>> ShutdownNodeAsyncWithHttpInfo(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

ShutdownNodeWithHttpInfo(Nullable<Int32>)

Special management endpoint to shutdown the node. Optionally provide a timeout parameter to indicate that the node should begin shutting down after a number of seconds.

Declaration

public ApiResponse<object> ShutdownNodeWithHttpInfo(int? timeout = default(int? ))

Parameters

Type	Name	Description
System.Nullable<System.Int32>	timeout	(optional, default to 0)

Returns

Type	Description
ApiResponse<System.Object>	ApiResponse of Object

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchup(String)

Starts a catchpoint catchup. Given a catchpoint, it starts catching up to this catchpoint

Declaration

public CatchpointStartResponse StartCatchup(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
CatchpointStartResponse	CatchpointStartResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupAsync(String)

Starts a catchpoint catchup. Given a catchpoint, it starts catching up to this catchpoint

Declaration

public Task<CatchpointStartResponse> StartCatchupAsync(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupAsyncWithHttpInfo(String)

Starts a catchpoint catchup. Given a catchpoint, it starts catching up to this catchpoint

Declaration

public Task<ApiResponse<CatchpointStartResponse>> StartCatchupAsyncWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

StartCatchupWithHttpInfo(String)

Starts a catchpoint catchup. Given a catchpoint, it starts catching up to this catchpoint

Declaration

public ApiResponse<CatchpointStartResponse> StartCatchupWithHttpInfo(string catchpoint)

Parameters

Type	Name	Description
System.String	catchpoint	A catch point

Returns

Type	Description
ApiResponse<CatchpointStartResponse>	ApiResponse of CatchpointStartResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IPrivateApi

IApiAccessor