Class SurveysPerformanceClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveysPerformanceClient

Inheritance

object

SurveysPerformanceClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveysPerformanceClient(string, HttpClient)

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

GetLiveSurveyMetricsAsync(string, CancellationToken)

Get the survey performance metrics for live interviews

public virtual Task<SurveyMetrics> GetLiveSurveyMetricsAsync(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<SurveyMetrics>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

GetTestSurveyMetricsV2Async(string, CancellationToken)

Get the survey performance metrics for test interviews

public virtual Task<SurveyMetrics> GetTestSurveyMetricsV2Async(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<SurveyMetrics>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T