Class SurveyGroupsAssignmentsClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class SurveyGroupsAssignmentsClient

Inheritance

object

SurveyGroupsAssignmentsClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SurveyGroupsAssignmentsClient(string, HttpClient)

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

GetDirectoryAssignmentsAsync(int, CancellationToken)

Get Survey Group directory assignments

public virtual Task<ICollection<SurveyGroupDirectoryAssignment>> GetDirectoryAssignmentsAsync(int surveyGroupId, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

cancellationToken CancellationToken

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

Returns

Task<ICollection<SurveyGroupDirectoryAssignment>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

GetLocalAssignmentsAsync(int, CancellationToken)

Get Survey Group local assignments

public virtual Task<ICollection<SurveyGroupNativeAssignment>> GetLocalAssignmentsAsync(int surveyGroupId, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

cancellationToken CancellationToken

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

Returns

Task<ICollection<SurveyGroupNativeAssignment>>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAssignDirectoryAsync(int, DirectoryIdentityModel, CancellationToken)

Assign directory user to survey group

public virtual Task<SurveyGroupDirectoryAssignmentModel> PutAssignDirectoryAsync(int surveyGroupId, DirectoryIdentityModel model, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

model DirectoryIdentityModel

cancellationToken CancellationToken

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

Returns

Task<SurveyGroupDirectoryAssignmentModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutAssignLocalAsync(int, NativeIdentityModel, CancellationToken)

Assign native user to survey group

public virtual Task<SurveyGroupNativeAssignmentModel> PutAssignLocalAsync(int surveyGroupId, NativeIdentityModel model, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

model NativeIdentityModel

cancellationToken CancellationToken

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

Returns

Task<SurveyGroupNativeAssignmentModel>

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutUnassignDirectoryAsync(int, UnassignDirectoryIdentityModel, CancellationToken)

Unassign directory user from survey group

public virtual Task PutUnassignDirectoryAsync(int surveyGroupId, UnassignDirectoryIdentityModel model, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

model UnassignDirectoryIdentityModel

cancellationToken CancellationToken

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

Returns

Task

Successful

Exceptions

NfieldSdkException

A server side error occurred.

PutUnassignLocalAsync(int, NativeIdentityModel, CancellationToken)

Unassign native user from survey group

public virtual Task PutUnassignLocalAsync(int surveyGroupId, NativeIdentityModel model, CancellationToken cancellationToken = default)

Parameters

surveyGroupId int

model NativeIdentityModel

cancellationToken CancellationToken

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

Returns

Task

Successful

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T