Class SurveysPublicIdsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysPublicIdsClient

Inheritance

object

SurveysPublicIdsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysPublicIdsClient(string, HttpClient)

public SurveysPublicIdsClient(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 list of public ids (internal test, external test and live) based on a survey.
This list can be filtered and sorted using standard OData syntax.

public virtual Task<ICollection<SurveyPublicIdModel>> 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<SurveyPublicIdModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, IEnumerable<SurveyPublicIdModel>, CancellationToken)

Update the survey public ids

public virtual Task PutAsync(string surveyId, IEnumerable<SurveyPublicIdModel> models, CancellationToken cancellationToken = default)

Parameters

surveyId string

The survey id

models IEnumerable<SurveyPublicIdModel>

The list of survey public ids

cancellationToken CancellationToken

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

Returns

Task

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T