Class SurveysEmailSettingsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysEmailSettingsClient

Inheritance

object

SurveysEmailSettingsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysEmailSettingsClient(string, HttpClient)

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

Get email settings for the survey.

public virtual Task<SurveyEmailSettingsResponse> GetAsync(string surveyId, CancellationToken cancellationToken = default)

Parameters

surveyId string

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<SurveyEmailSettingsResponse>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, InvitationSurveyEmailSettings, CancellationToken)

Update email settings for the survey.

public virtual Task<SurveyEmailSettingsModel> PutAsync(string surveyId, InvitationSurveyEmailSettings surveyEmailSettings, CancellationToken cancellationToken = default)

Parameters

surveyId string

id of the survey

surveyEmailSettings InvitationSurveyEmailSettings

new email settings

cancellationToken CancellationToken

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

Returns

Task<SurveyEmailSettingsModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T