Class ProfileClient

Inheritance

object

ClientBase

ProfileClient

Inherited Members

ClientBase.BaseUrl

ClientBase.CustomerAlias

ClientBase.CreateHttpRequestMessageAsync(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: System.Dynamic.ExpandoObject

Syntax

[GeneratedCode("NSwag", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
public class ProfileClient : ClientBase, IProfileClient

Constructors

ProfileClient(IPictureparkServiceSettings, HttpClient)

Declaration

public ProfileClient(IPictureparkServiceSettings configuration, HttpClient httpClient)

Parameters

IPictureparkServiceSettings configuration

HttpClient httpClient

Properties

JsonSerializerSettings

Declaration

protected JsonSerializerSettings JsonSerializerSettings { get; }

Property Value

JsonSerializerSettings

ReadResponseAsString

Declaration

public bool ReadResponseAsString { get; set; }

Property Value

bool

Methods

GetAsync(CancellationToken)

Get

Declaration

public virtual Task<UserProfile> GetAsync(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<UserProfile> User profile

Implements

IProfileClient.GetAsync(CancellationToken)

Remarks

Get profile of currently logged in user.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

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

Declaration

protected virtual Task<ProfileClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)

Parameters

HttpResponseMessage response

IReadOnlyDictionary<string, IEnumerable<string>> headers

CancellationToken cancellationToken

Returns

Task<ProfileClient.ObjectResponseResult<T>>

Type Parameters

T

RequestDeletionAsync(CancellationToken)

Request deletion

Declaration

public virtual Task RequestDeletionAsync(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 OK

Implements

IProfileClient.RequestDeletionAsync(CancellationToken)

Remarks

Requests deletion of the current user profile.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error

UpdateAsync(UserProfileUpdateRequest, CancellationToken)

Update

Declaration

public virtual Task<UserProfile> UpdateAsync(UserProfileUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

UserProfileUpdateRequest request Request to update a user profile..

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

Returns

Task<UserProfile> Updated user profile

Implements

IProfileClient.UpdateAsync(UserProfileUpdateRequest, CancellationToken)

Remarks

Updates profile of currently logged in user.

Exceptions

ApiException A server side error occurred.

PictureparkValidationException Validation exception

PictureparkForbiddenException Forbidden

PictureparkNotFoundException Entity not found

PictureparkConflictException Version conflict

PictureparkTooManyRequestsException Too many requests

PictureparkException Internal server error