Class SurveysManualTestClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysManualTestClient

Inheritance

object

SurveysManualTestClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysManualTestClient(string, HttpClient)

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

GetManualTestsAsync(CancellationToken)

Retrieve all manual test surveys of the domain

public virtual Task<ICollection<SurveyManualTestModel>> GetManualTestsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

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

Returns

Task<ICollection<SurveyManualTestModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

GetSurveyManualTestsAsync(string, CancellationToken)

Retrieve all the manual test surveys of a survey (normally just one)

public virtual Task<ICollection<SurveyManualTestModel>> GetSurveyManualTestsAsync(string surveyId, CancellationToken cancellationToken = default)

Parameters

surveyId string

The surveyId 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<SurveyManualTestModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(string, bool?, bool?, FileParameter, CancellationToken)

Method used to start the creation of a manual test survey

public virtual Task<BackgroundActivityStatus> PostAsync(string surveyId, bool? enableReporting = null, bool? useOriginalSample = null, FileParameter sampleDataFile = null, CancellationToken cancellationToken = default)

Parameters

surveyId string

enableReporting bool?

useOriginalSample bool?

sampleDataFile FileParameter

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<SurveysManualTestClient.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<SurveysManualTestClient.ObjectResponseResult<T>>

Type Parameters

T