Table of Contents

Class PaginatedKeyClient

Namespace
Crews.PlanningCenter.Api.Services.V2018_08_01
Assembly
Crews.PlanningCenter.Api.dll

Client for interacting with Key collection resources.

public class PaginatedKeyClient : PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>
Inheritance
PaginatedKeyClient
Inherited Members

Constructors

PaginatedKeyClient(HttpClient, Uri)

Client for interacting with Key collection resources.

public PaginatedKeyClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient
uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Key resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<KeyCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public KeyClient OrderByCreatedAt()

Returns

KeyClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public KeyClient OrderByCreatedAtDescending()

Returns

KeyClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public KeyClient OrderByUpdatedAt()

Returns

KeyClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public KeyClient OrderByUpdatedAtDescending()

Returns

KeyClient

PostAsync(Key, CancellationToken)

Creates a new Key resource asynchronously.

public Task<KeyResponse> PostAsync(Key resource, CancellationToken cancellationToken = default)

Parameters

resource Key

The resource data to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<KeyResponse>

A task representing the asynchronous operation, containing the created Key resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PostAsync(JsonApiDocument<KeyResource>, CancellationToken)

Creates a new Key resource asynchronously.

public Task<KeyResponse> PostAsync(JsonApiDocument<KeyResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<KeyResource>

The JSON:API document to be sent in the POST request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<KeyResponse>

A task representing the asynchronous operation, containing the created Key resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public KeyClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

KeyClient

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

Edit this page