Class PaginatedCheckInTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with CheckInTime collection resources.

public class PaginatedCheckInTimeClient : PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>

Inheritance

object

ResourceClient<CheckInTime>

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>

PaginatedCheckInTimeClient

Inherited Members

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.PerPage(int)

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.Offset(int)

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.Filter(string)

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.PostAsync(CheckInTime, CancellationToken)

PaginatedResourceClient<CheckInTime, CheckInTimeResource, CheckInTimeCollectionResponse, CheckInTimeResponse>.PostAsync(JsonApiDocument<CheckInTimeResource>, CancellationToken)

ResourceClient<CheckInTime>.AddQueryParameter(string, string)

ResourceClient<CheckInTime>.ReplaceQueryParameter(string, string)

ResourceClient<CheckInTime>.AddCustomParameter(string, string)

ResourceClient<CheckInTime>.ClearParameters()

ResourceClient<CheckInTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckInTime>.Uri

ResourceClient<CheckInTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCheckInTimeClient(HttpClient, Uri)

Client for interacting with CheckInTime collection resources.

public PaginatedCheckInTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of CheckInTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public CheckInTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CheckInTimeClient

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