Class PersonalAccessTokenClient

Namespace

Crews.PlanningCenter.Api.Api.V2019_02_13

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PersonalAccessToken resource.

public class PersonalAccessTokenClient : SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>

Inheritance

object

ResourceClient<PersonalAccessToken>

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>

PersonalAccessTokenClient

Inherited Members

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>.PatchAsync(PersonalAccessToken, CancellationToken)

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>.PatchAsync(JsonApiDocument<PersonalAccessTokenResource>, CancellationToken)

SingletonResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenResponse>.DeleteAsync(CancellationToken)

ResourceClient<PersonalAccessToken>.AddQueryParameter(string, string)

ResourceClient<PersonalAccessToken>.ReplaceQueryParameter(string, string)

ResourceClient<PersonalAccessToken>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonalAccessToken>.Uri

ResourceClient<PersonalAccessToken>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonalAccessTokenClient(HttpClient, Uri)

Client for interacting with the PersonalAccessToken resource.

public PersonalAccessTokenClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PersonalAccessTokenClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PersonalAccessTokenClient

The current PersonalAccessTokenClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PersonalAccessTokenClient ClearParameters()

Returns

PersonalAccessTokenClient

The current PersonalAccessTokenClient instance.

GetAsync(CancellationToken)

Fetches the PersonalAccessToken resource asynchronously.

public Task<PersonalAccessTokenResponse> GetAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonalAccessTokenResponse>

A task representing the asynchronous operation, containing the PersonalAccessToken resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.