Class SurveysSampleDataClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysSampleDataClient

Inheritance

object

SurveysSampleDataClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysSampleDataClient(string, HttpClient)

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

PostPrepareDownloadSampleDataAsync(string, string, CancellationToken)

Creates a background activity that prepares the sample data file for download

public virtual Task<BackgroundActivityStatus> PostPrepareDownloadSampleDataAsync(string surveyId, string fileName, CancellationToken cancellationToken = default)

Parameters

surveyId string

Unique identifier of the survey whose sample data is requested.

fileName string

Name of the file to generate.

cancellationToken CancellationToken

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

Returns

Task<BackgroundActivityStatus>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T