Class PaginatedCheckInTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCheckInTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCheckInTimeClient

The current PaginatedCheckInTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCheckInTimeClient ClearParameters()

Returns

PaginatedCheckInTimeClient

The current PaginatedCheckInTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCheckInTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCheckInTimeClient

The current PaginatedCheckInTimeClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCheckInTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCheckInTimeClient

The current PaginatedCheckInTimeClient instance.

PerPage(int)

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

public PaginatedCheckInTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCheckInTimeClient

The current PaginatedCheckInTimeClient instance.

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.