Class PaginatedPassClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Pass collection resources.

public class PaginatedPassClient : PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>

Inheritance

object

ResourceClient<Pass>

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>

PaginatedPassClient

Inherited Members

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.PerPage(int)

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.Offset(int)

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.Filter(string)

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.PostAsync(Pass, CancellationToken)

PaginatedResourceClient<Pass, PassResource, PassCollectionResponse, PassResponse>.PostAsync(JsonApiDocument<PassResource>, CancellationToken)

ResourceClient<Pass>.AddQueryParameter(string, string)

ResourceClient<Pass>.ReplaceQueryParameter(string, string)

ResourceClient<Pass>.AddCustomParameter(string, string)

ResourceClient<Pass>.ClearParameters()

ResourceClient<Pass>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Pass>.Uri

ResourceClient<Pass>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPassClient(HttpClient, Uri)

Client for interacting with Pass collection resources.

public PaginatedPassClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Pass resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PassCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public PassClient IncludePerson()

Returns

PassClient

WhereCode(string)

Query response items by the Code attribute.

public PassClient WhereCode(string value)

Parameters

value string

Returns

PassClient

WithId(string)

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

public PassClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PassClient

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