Class SurveysDataRetentionClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysDataRetentionClient

Inheritance

object

SurveysDataRetentionClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysDataRetentionClient(string, HttpClient)

public SurveysDataRetentionClient(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 data retention settings for a survey

public virtual Task<GetDataRetentionSettingsModel> 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<GetDataRetentionSettingsModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, UpdateDataRetentionSettingsModel, CancellationToken)

Update the data retention settings for a survey

public virtual Task PutAsync(string surveyId, UpdateDataRetentionSettingsModel settings, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey

settings UpdateDataRetentionSettingsModel

Object containing the data retention settings

cancellationToken CancellationToken

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

Returns

Task

Survey Data Retention Settings updated

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T