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

object

ResourceClient<Key>

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>

PaginatedKeyClient

Inherited Members

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.PerPage(int)

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.Offset(int)

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.Filter(string)

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.PostAsync(Key, CancellationToken)

PaginatedResourceClient<Key, KeyResource, KeyCollectionResponse, KeyResponse>.PostAsync(JsonApiDocument<KeyResource>, CancellationToken)

ResourceClient<Key>.AddQueryParameter(string, string)

ResourceClient<Key>.ReplaceQueryParameter(string, string)

ResourceClient<Key>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Key>.Uri

ResourceClient<Key>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedKeyClient(HttpClient, Uri)

Client for interacting with Key collection resources.

public PaginatedKeyClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedKeyClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedKeyClient

The current PaginatedKeyClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedKeyClient ClearParameters()

Returns

PaginatedKeyClient

The current PaginatedKeyClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedKeyClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedKeyClient

The current PaginatedKeyClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedKeyClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedKeyClient

The current PaginatedKeyClient instance.

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

PerPage(int)

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

public PaginatedKeyClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedKeyClient

The current PaginatedKeyClient instance.

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.