Class SurveysSettingsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysSettingsClient

Inheritance

object

SurveysSettingsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysSettingsClient(string, HttpClient)

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

This method retrieves the settings for the survey with the specified surveyId.

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

Parameters

surveyId string

The 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<ICollection<SurveySettingModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(string, SurveySettingModel, CancellationToken)

This method add settings for specified surveyId.

Update settings if it's already created.

public virtual Task<SurveySettingModel> PostAsync(string surveyId, SurveySettingModel surveySettings, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey

surveySettings SurveySettingModel

An object describing the details for the settings

cancellationToken CancellationToken

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

Returns

Task<SurveySettingModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T