Class DomainSearchFieldsSettingClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainSearchFieldsSettingClient

Inheritance

object

DomainSearchFieldsSettingClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainSearchFieldsSettingClient(string, HttpClient)

public DomainSearchFieldsSettingClient(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(CancellationToken)

Gets the domain's search fields.

public virtual Task<SearchFieldsResponseModel> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

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

Returns

Task<SearchFieldsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(SearchFieldsRequestModel, CancellationToken)

Update the domain's search fields.

public virtual Task<SearchFieldsResponseModel> PutAsync(SearchFieldsRequestModel searchFields, CancellationToken cancellationToken = default)

Parameters

searchFields SearchFieldsRequestModel

Fields where search for respondent data. The maximum number of fields is 5.

cancellationToken CancellationToken

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

Returns

Task<SearchFieldsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T