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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPersonalAccessTokenClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPersonalAccessTokenClient

The current PaginatedPersonalAccessTokenClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPersonalAccessTokenClient ClearParameters()

Returns

PaginatedPersonalAccessTokenClient

The current PaginatedPersonalAccessTokenClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPersonalAccessTokenClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPersonalAccessTokenClient

The current PaginatedPersonalAccessTokenClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPersonalAccessTokenClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPersonalAccessTokenClient

The current PaginatedPersonalAccessTokenClient instance.

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedPersonalAccessTokenClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPersonalAccessTokenClient

The current PaginatedPersonalAccessTokenClient instance.

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.