Class SurveysPublishStartClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysPublishStartClient

Inheritance

object

SurveysPublishStartClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysPublishStartClient(string, HttpClient)

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

PostAsync(string, SurveyPublishTypeUpgradeModel, CancellationToken)

Creates an activity that starts the publishing process. Use the activity id to wait for the publish result.

public virtual Task<BackgroundActivityStatus> PostAsync(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<BackgroundActivityStatus>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T