Class PaginatedPersonalAccessTokenClient

Namespace

Crews.PlanningCenter.Api.Api.V2019_02_13

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PersonalAccessToken collection resources.

public class PaginatedPersonalAccessTokenClient : PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>

Inheritance

object

ResourceClient<PersonalAccessToken>

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>

PaginatedPersonalAccessTokenClient

Inherited Members

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.PerPage(int)

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.Offset(int)

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.Filter(string)

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.PostAsync(PersonalAccessToken, CancellationToken)

PaginatedResourceClient<PersonalAccessToken, PersonalAccessTokenResource, PersonalAccessTokenCollectionResponse, PersonalAccessTokenResponse>.PostAsync(JsonApiDocument<PersonalAccessTokenResource>, CancellationToken)

ResourceClient<PersonalAccessToken>.AddQueryParameter(string, string)

ResourceClient<PersonalAccessToken>.ReplaceQueryParameter(string, string)

ResourceClient<PersonalAccessToken>.AddCustomParameter(string, string)

ResourceClient<PersonalAccessToken>.ClearParameters()

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

PaginatedPersonalAccessTokenClient(HttpClient, Uri)

Client for interacting with PersonalAccessToken collection resources.

public PaginatedPersonalAccessTokenClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of PersonalAccessToken resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonalAccessTokenCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of PersonalAccessToken resources.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

Creates a new instance of a PersonalAccessToken client for a specific resource ID.

public PersonalAccessTokenClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonalAccessTokenClient

A new instance of the resource client for the specified resource ID.