Class SurveysScreenerChildrenConditionsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysScreenerChildrenConditionsClient

Inheritance

object

SurveysScreenerChildrenConditionsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysScreenerChildrenConditionsClient(string, HttpClient)

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

CreateScreenerChildConditionAsync(string, string, ScreenerCreateChildConditionModel, CancellationToken)

Creates a new screener child condition

public virtual Task<ScreenerChildConditionModel> CreateScreenerChildConditionAsync(string screenerId, string childId, ScreenerCreateChildConditionModel screenerChildCondition, CancellationToken cancellationToken = default)

Parameters

screenerId string

The screener survey ID

childId string

The child survey ID

screenerChildCondition ScreenerCreateChildConditionModel

The screener child condition to create

cancellationToken CancellationToken

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

Returns

Task<ScreenerChildConditionModel>

Created

Exceptions

NfieldSdkException

A server side error occurred.

DeleteScreenerChildConditionAsync(string, int, CancellationToken)

Deletes an existing screener child condition

public virtual Task DeleteScreenerChildConditionAsync(string screenerId, int conditionId, CancellationToken cancellationToken = default)

Parameters

screenerId string

The screener survey ID

conditionId int

The screener child condition ID

cancellationToken CancellationToken

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

Returns

Task

No Content

Exceptions

NfieldSdkException

A server side error occurred.

GetScreenerChildrenConditionsAsync(string, CancellationToken)

Gets screener children conditions

public virtual Task<ICollection<ScreenerChildConditionModel>> GetScreenerChildrenConditionsAsync(string screenerId, CancellationToken cancellationToken = default)

Parameters

screenerId string

The screener survey ID

cancellationToken CancellationToken

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

Returns

Task<ICollection<ScreenerChildConditionModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T

UpdateScreenerChildConditionsAsync(string, IEnumerable<ScreenerChildConditionModel>, CancellationToken)

Updates existing screener children conditions

public virtual Task<ICollection<ScreenerChildConditionModel>> UpdateScreenerChildConditionsAsync(string screenerId, IEnumerable<ScreenerChildConditionModel> screenerChildConditions, CancellationToken cancellationToken = default)

Parameters

screenerId string

The screener survey ID

screenerChildConditions IEnumerable<ScreenerChildConditionModel>

The screener child conditions to update

cancellationToken CancellationToken

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

Returns

Task<ICollection<ScreenerChildConditionModel>>

Updated

Exceptions

NfieldSdkException

A server side error occurred.