Class PaginatedCheckInGroupClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with CheckInGroup collection resources.

public class PaginatedCheckInGroupClient : PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>

Inheritance

object

ResourceClient<CheckInGroup>

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>

PaginatedCheckInGroupClient

Inherited Members

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.PerPage(int)

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.Offset(int)

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.Filter(string)

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.PostAsync(CheckInGroup, CancellationToken)

PaginatedResourceClient<CheckInGroup, CheckInGroupResource, CheckInGroupCollectionResponse, CheckInGroupResponse>.PostAsync(JsonApiDocument<CheckInGroupResource>, CancellationToken)

ResourceClient<CheckInGroup>.AddQueryParameter(string, string)

ResourceClient<CheckInGroup>.ReplaceQueryParameter(string, string)

ResourceClient<CheckInGroup>.AddCustomParameter(string, string)

ResourceClient<CheckInGroup>.ClearParameters()

ResourceClient<CheckInGroup>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckInGroup>.Uri

ResourceClient<CheckInGroup>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCheckInGroupClient(HttpClient, Uri)

Client for interacting with CheckInGroup collection resources.

public PaginatedCheckInGroupClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of CheckInGroup resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInGroupCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCheckIns()

Include related CheckIns resources in the response.

public CheckInGroupClient IncludeCheckIns()

Returns

CheckInGroupClient

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public CheckInGroupClient IncludeEventPeriod()

Returns

CheckInGroupClient

IncludePrintStation()

Include related PrintStation resources in the response.

public CheckInGroupClient IncludePrintStation()

Returns

CheckInGroupClient

WithId(string)

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

public CheckInGroupClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CheckInGroupClient

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