Class SurveysDialModeClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysDialModeClient

Inheritance

object

SurveysDialModeClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysDialModeClient(string, HttpClient)

public SurveysDialModeClient(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)

Get the dial mode for the survey

public virtual Task<DialModeModel> GetAsync(string surveyId, CancellationToken cancellationToken = default)

Parameters

surveyId string

id of the survey

cancellationToken CancellationToken

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

Returns

Task<DialModeModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PatchAsync(string, DialModeModel, CancellationToken)

Update the dial mode for the survey

public virtual Task PatchAsync(string surveyId, DialModeModel dialModeRequestModel, CancellationToken cancellationToken = default)

Parameters

surveyId string

id of the survey

dialModeRequestModel DialModeModel

the new dial mode

cancellationToken CancellationToken

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

Returns

Task

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T