Class DomainDeliveryRepositoriesUsersClient

Namespace

Nfield.SDK

Assembly

Nfield.Public.SDK.dll

public class DomainDeliveryRepositoriesUsersClient

Inheritance

object

DomainDeliveryRepositoriesUsersClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DomainDeliveryRepositoriesUsersClient(string, HttpClient)

public DomainDeliveryRepositoriesUsersClient(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(long, long, CancellationToken)

Deletes the specified user from the Repository database.

public virtual Task DeleteAsync(long repositoryId, long userId, CancellationToken cancellationToken = default)

Parameters

repositoryId long

The repository id.

userId long

The id of the user to delete.

cancellationToken CancellationToken

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

Returns

Task

Deletes the specified user from the Repository database

Exceptions

NfieldSdkException

A server side error occurred.

GetAsync(long, long, CancellationToken)

Gets a repository user by specified id.

public virtual Task<RepositoryUserModel> GetAsync(long repositoryId, long userId, CancellationToken cancellationToken = default)

Parameters

repositoryId long

The repository id.

userId long

The user id.

cancellationToken CancellationToken

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

Returns

Task<RepositoryUserModel>

Returns the User

Exceptions

NfieldSdkException

A server side error occurred.

GetRepositoryUsersAsync(long, CancellationToken)

Returns the list of repository users.

public virtual Task<ICollection<RepositoryUserModel>> GetRepositoryUsersAsync(long repositoryId, CancellationToken cancellationToken = default)

Parameters

repositoryId long

The repository id.

cancellationToken CancellationToken

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

Returns

Task<ICollection<RepositoryUserModel>>

Returns the list of repository users.

Exceptions

NfieldSdkException

A server side error occurred.

PostAsync(long, string, CancellationToken)

Creates a new repository user based on the given data.

public virtual Task PostAsync(long repositoryId, string repositoryUserName, CancellationToken cancellationToken = default)

Parameters

repositoryId long

The repository id.

repositoryUserName string

The selected username for the repository user to create.

cancellationToken CancellationToken

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

Returns

Task

Returns the user password

Exceptions

NfieldSdkException

A server side error occurred.

PostResetUserPasswordAsync(long, long, CancellationToken)

Resets the repository user password.

public virtual Task PostResetUserPasswordAsync(long repositoryId, long userId, CancellationToken cancellationToken = default)

Parameters

repositoryId long

The repository id.

userId long

The repository user id.

cancellationToken CancellationToken

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

Returns

Task

Returns the user's new password

Exceptions

NfieldSdkException

A server side error occurred.

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

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

Type Parameters

T