Class DomainRequestsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainRequestsClient

Inheritance

object

DomainRequestsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainRequestsClient(string, HttpClient)

public DomainRequestsClient(string baseUrl, HttpClient httpClient)

Parameters

baseUrl string

httpClient HttpClient

Properties

BaseUrl

public string BaseUrl { get; set; }

Property Value

string

JsonSerializerSettings

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

DeleteAsync(int, CancellationToken)

Delete request configuration

public virtual Task DeleteAsync(int requestId, CancellationToken cancellationToken = default)

Parameters

requestId int

cancellationToken CancellationToken

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

Returns

Task

Request configuration deleted

Exceptions

NfieldSdkException

A server side error occurred.

GetAllAsync(string, CancellationToken)

List all request configurations if no filter is provided.
Request can be filtered with a query parameter name.
Requests?name={name}

public virtual Task<object> GetAllAsync(string name = null, CancellationToken cancellationToken = default)

Parameters

name string

cancellationToken CancellationToken

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

Returns

Task<object>

Returns the list of Requests
or
Returns a single Request

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(int, CancellationToken)

Get request configuration by id

public virtual Task<RequestModel> GetAsync(int requestId, CancellationToken cancellationToken = default)

Parameters

requestId int

cancellationToken CancellationToken

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

Returns

Task<RequestModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(RequestModel, CancellationToken)

Create a new request configuration

public virtual Task PostAsync(RequestModel request, CancellationToken cancellationToken = default)

Parameters

request RequestModel

cancellationToken CancellationToken

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

Returns

Task

Request configuration created

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(RequestModel, CancellationToken)

Update existing request configuration

public virtual Task<Request> PutAsync(RequestModel request, CancellationToken cancellationToken = default)

Parameters

request RequestModel

cancellationToken CancellationToken

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

Returns

Task<Request>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)

protected virtual Task<DomainRequestsClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

response HttpResponseMessage

headers IReadOnlyDictionary<string, IEnumerable<string>>

cancellationToken CancellationToken

Returns

Task<DomainRequestsClient.ObjectResponseResult<T>>

Type Parameters

T