Class BackgroundActivityClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class BackgroundActivityClient

Inheritance

object

BackgroundActivityClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BackgroundActivityClient(string, HttpClient)

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

GetAsync(string, CancellationToken)

Retrieve the details of an specific background activity, including its type, identifiers, timestamps, and the user who initiated it.

public virtual Task<BackgroundActivityResponseModel> GetAsync(string activityId, CancellationToken cancellationToken = default)

Parameters

activityId string

Unique identifier of the background activity.

cancellationToken CancellationToken

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

Returns

Task<BackgroundActivityResponseModel>

Background Activity

Exceptions

NfieldSdkException

A server side error occurred.

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

protected virtual Task<BackgroundActivityClient.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<BackgroundActivityClient.ObjectResponseResult<T>>

Type Parameters

T