Class SurveysPublishClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysPublishClient

Inheritance

object

SurveysPublishClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysPublishClient(string, HttpClient)

public SurveysPublishClient(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)

Gets the published state of the survey in the context.

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

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, SurveyPublishTypeUpgradeModel, CancellationToken)

Publishes the survey to the survey package.

public virtual Task PutAsync(string surveyId, SurveyPublishTypeUpgradeModel surveyPublishTypeUpgrade, CancellationToken cancellationToken = default)

Parameters

surveyId string

The id of the survey.

surveyPublishTypeUpgrade SurveyPublishTypeUpgradeModel

A model that contains the interview package type
and force interviews on older packages to upgrade to this package

cancellationToken CancellationToken

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

Returns

Task

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T