Class SurveysGeneralSettingsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysGeneralSettingsClient

Inheritance

object

SurveysGeneralSettingsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysGeneralSettingsClient(string, HttpClient)

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

GetSettingsAsync(string, CancellationToken)

Retrieve details of a specific survey general settings.

public virtual Task<SurveyGeneralSettingsResponseModel> GetSettingsAsync(string surveyId, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey general setting

cancellationToken CancellationToken

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

Returns

Task<SurveyGeneralSettingsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(string, SurveyGeneralSettingsRequestV1Model, CancellationToken)

Update a survey general settings.

public virtual Task<SurveyGeneralSettingsResponseModel> PostAsync(string surveyId, SurveyGeneralSettingsRequestV1Model surveyGeneralSettings, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey general settings to update

surveyGeneralSettings SurveyGeneralSettingsRequestV1Model

Client, Description, Name and Owner of the survey general setting

cancellationToken CancellationToken

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

Returns

Task<SurveyGeneralSettingsResponseModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T