Class DomainCatiInterviewersClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainCatiInterviewersClient

Inheritance

object

DomainCatiInterviewersClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainCatiInterviewersClient(string, HttpClient)

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

DeleteAsync(string, CancellationToken)

This method deletes a specified interviewer.

public virtual Task DeleteAsync(string interviewerId, CancellationToken cancellationToken = default)

Parameters

interviewerId string

The id of the interviewer that is to be deleted

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.

GetAllAsync(CancellationToken)

This method retrieve a list of interviewers. This list can be
filtered and sorted using standard OData syntax.

public virtual Task<ICollection<CatiInterviewer>> GetAllAsync(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<CatiInterviewer>>

Cati Interviewers

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(string, CancellationToken)

This method retrieve details of a specific interviewer using the interviewerId.

public virtual Task<CatiInterviewer> GetAsync(string interviewerId, CancellationToken cancellationToken = default)

Parameters

interviewerId string

The id of the interviewer

cancellationToken CancellationToken

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

Returns

Task<CatiInterviewer>

Cati Interviewer by id

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(CatiInterviewerModel, CancellationToken)

This method creates a new interviewer.

public virtual Task<CatiInterviewer> PostAsync(CatiInterviewerModel interviewer, CancellationToken cancellationToken = default)

Parameters

interviewer CatiInterviewerModel

An object describing the details for the new interviewer

cancellationToken CancellationToken

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

Returns

Task<CatiInterviewer>

Capi Interviewer updated

Exceptions

NfieldSdkException

A server side error occurred.

PutAsync(string, ResetPasswordModel, CancellationToken)

This method is used to reset an interviewer's password.

public virtual Task<CatiInterviewer> PutAsync(string interviewerId, ResetPasswordModel resetPassword, CancellationToken cancellationToken = default)

Parameters

interviewerId string

The id of the interviewer to reset the password for

resetPassword ResetPasswordModel

An object containing the new password

cancellationToken CancellationToken

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

Returns

Task<CatiInterviewer>

Capi Interviewer updated

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T