Class SurveysScreenersClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysScreenersClient

Inheritance

object

SurveysScreenersClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysScreenersClient(string, HttpClient)

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

CreateScreenerAsync(ScreenerCreateRequestModel, CancellationToken)

Create a new ONLINE screener survey.

public virtual Task<SurveyModel> CreateScreenerAsync(ScreenerCreateRequestModel newScreener, CancellationToken cancellationToken = default)

Parameters

newScreener ScreenerCreateRequestModel

A model describing the details for the new screener survey

cancellationToken CancellationToken

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

Returns

Task<SurveyModel>

Created

Exceptions

NfieldSdkException

A server side error occurred.

GetScreenersAsync(CancellationToken)

Retrieve all screener surveys. This list can be filtered and sorted
using standard OData syntax.

public virtual Task<ICollection<SurveyModel>> GetScreenersAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

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

Returns

Task<ICollection<SurveyModel>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T