Class Client

Inheritance

System.Object

Client

Implements

IClient

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: VEDriversLite.DogeAPI

Assembly: VEDriversLite.dll

Syntax

public class Client : IClient

Constructors

| Improve this Doc View Source

Client(HttpClient)

Declaration

public Client(HttpClient httpClient)

Parameters

Type	Name	Description
System.Net.Http.HttpClient	httpClient

Properties

| Improve this Doc View Source

APIKey

Declaration

public string APIKey { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

BaseUrl

Declaration

public string BaseUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

Type	Description
Newtonsoft.Json.JsonSerializerSettings

| Improve this Doc View Source

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

BroadcastTxAsync(BroadcastTxRequest)

Broadcasts a signed raw transaction to the network

Declaration

public Task<BroadcastTxResponse> BroadcastTxAsync(BroadcastTxRequest body)

Parameters

Type	Name	Description
BroadcastTxRequest	body

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

BroadcastTxAsync(BroadcastTxRequest, CancellationToken)

Broadcasts a signed raw transaction to the network

Declaration

public async Task<BroadcastTxResponse> BroadcastTxAsync(BroadcastTxRequest body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
BroadcastTxRequest	body
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ChainSoBroadcastTxAsync(ChainSoBroadcastTxRequest)

Broadcasts a signed raw transaction to the network

Declaration

public Task<BroadcastTxResponse> ChainSoBroadcastTxAsync(ChainSoBroadcastTxRequest body)

Parameters

Type	Name	Description
ChainSoBroadcastTxRequest	body

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ChainSoBroadcastTxAsync(ChainSoBroadcastTxRequest, CancellationToken)

Broadcasts a signed raw transaction to the network

Declaration

public async Task<BroadcastTxResponse> ChainSoBroadcastTxAsync(ChainSoBroadcastTxRequest body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ChainSoBroadcastTxRequest	body
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressBalanceAsync(String)

Returns the doge balance

Declaration

public Task<GetAddressBalanceResponse> GetAddressBalanceAsync(string address)

Parameters

Type	Name	Description
System.String	address	Doge address

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressBalanceResponse>	Object containing doge balance, if address symbol does not exist on network, empty object is returned.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressBalanceAsync(String, CancellationToken)

Returns the doge balance

Declaration

public async Task<GetAddressBalanceResponse> GetAddressBalanceAsync(string address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	address	Doge address
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressBalanceResponse>	Object containing doge balance, if address symbol does not exist on network, empty object is returned.

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressReceivedTxAsync(String)

Doge Address received transactions

Declaration

public Task<GetAddressReceivedTxsResponse> GetAddressReceivedTxAsync(string address)

Parameters

Type	Name	Description
System.String	address	Doge Address

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressReceivedTxsResponse>	Object containing collection of Spended transactions

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressReceivedTxAsync(String, CancellationToken)

Doge Address Unspended transactions

Declaration

public async Task<GetAddressReceivedTxsResponse> GetAddressReceivedTxAsync(string address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	address	Doge Address
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressReceivedTxsResponse>	Object containing collection of Utxos

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressSentTxAsync(String)

Doge Address spended transactions

Declaration

public Task<GetAddressSpentTxsResponse> GetAddressSentTxAsync(string address)

Parameters

Type	Name	Description
System.String	address	Doge Address

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressSpentTxsResponse>	Object containing collection of Spended transactions

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressSentTxAsync(String, CancellationToken)

Doge Address Unspended transactions

Declaration

public async Task<GetAddressSpentTxsResponse> GetAddressSentTxAsync(string address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	address	Doge Address
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressSpentTxsResponse>	Object containing collection of Utxos

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressUtxosAsync(String)

Doge Address Unspended transactions

Declaration

public Task<GetAddressUtxosResponse> GetAddressUtxosAsync(string address)

Parameters

Type	Name	Description
System.String	address	Doge Address

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressUtxosResponse>	Object containing collection of Utxos

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetAddressUtxosAsync(String, CancellationToken)

Doge Address Unspended transactions

Declaration

public async Task<GetAddressUtxosResponse> GetAddressUtxosAsync(string address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	address	Doge Address
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<GetAddressUtxosResponse>	Object containing collection of Utxos

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetTransactionInfoAsync(String)

Information On an Doge Transaction

Declaration

public Task<GetTransactionInfoResponse> GetTransactionInfoAsync(string txid)

Parameters

Type	Name	Description
System.String	txid	Doge txid to get information on.

Returns

Type	Description
System.Threading.Tasks.Task<GetTransactionInfoResponse>	An object represending this transaction

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

GetTransactionInfoAsync(String, CancellationToken)

Information On an Doge Transaction

Declaration

public async Task<GetTransactionInfoResponse> GetTransactionInfoAsync(string txid, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.String	txid	Doge txid to get information on.
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<GetTransactionInfoResponse>	An object represending this transaction

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>)

Declaration

protected virtual async Task<Client.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers)

Parameters

Type	Name	Description
System.Net.Http.HttpResponseMessage	response
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>>	headers

Returns

Type	Description
System.Threading.Tasks.Task<Client.ObjectResponseResult<T>>

Type Parameters

Name	Description
T

| Improve this Doc View Source

VENFTBroadcastTxAsync(VENFTBroadcastTxRequest)

Broadcasts a signed raw transaction to the network

Declaration

public Task<BroadcastTxResponse> VENFTBroadcastTxAsync(VENFTBroadcastTxRequest body)

Parameters

Type	Name	Description
VENFTBroadcastTxRequest	body

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

| Improve this Doc View Source

VENFTBroadcastTxAsync(VENFTBroadcastTxRequest, CancellationToken)

Broadcasts a signed raw transaction to the network

Declaration

public async Task<BroadcastTxResponse> VENFTBroadcastTxAsync(VENFTBroadcastTxRequest body, CancellationToken cancellationToken)

Parameters

Type	Name	Description
VENFTBroadcastTxRequest	body
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Type	Description
System.Threading.Tasks.Task<BroadcastTxResponse>	An object containing the TXID if the broadcast was successful

Exceptions

Type	Condition
ApiException	A server side error occurred.

Implements

IClient