Class PaginatedCheckInClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2019_07_17

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with CheckIn collection resources.

public class PaginatedCheckInClient : PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>

Inheritance

object

ResourceClient<CheckIn>

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>

PaginatedCheckInClient

Inherited Members

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.PerPage(int)

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.Offset(int)

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.Filter(string)

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.PostAsync(CheckIn, CancellationToken)

PaginatedResourceClient<CheckIn, CheckInResource, CheckInCollectionResponse, CheckInResponse>.PostAsync(JsonApiDocument<CheckInResource>, CancellationToken)

ResourceClient<CheckIn>.AddQueryParameter(string, string)

ResourceClient<CheckIn>.ReplaceQueryParameter(string, string)

ResourceClient<CheckIn>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<CheckIn>.Uri

ResourceClient<CheckIn>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCheckInClient(HttpClient, Uri)

Client for interacting with CheckIn collection resources.

public PaginatedCheckInClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCheckInClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCheckInClient

The current PaginatedCheckInClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCheckInClient ClearParameters()

Returns

PaginatedCheckInClient

The current PaginatedCheckInClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCheckInClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCheckInClient

The current PaginatedCheckInClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of CheckIn resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CheckInCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCheckInTimes()

Include related CheckInTimes resources in the response.

public CheckInClient IncludeCheckInTimes()

Returns

CheckInClient

IncludeCheckedInAt()

Include related CheckedInAt resources in the response.

public CheckInClient IncludeCheckedInAt()

Returns

CheckInClient

IncludeCheckedInBy()

Include related CheckedInBy resources in the response.

public CheckInClient IncludeCheckedInBy()

Returns

CheckInClient

IncludeCheckedOutBy()

Include related CheckedOutBy resources in the response.

public CheckInClient IncludeCheckedOutBy()

Returns

CheckInClient

IncludeEvent()

Include related Event resources in the response.

public CheckInClient IncludeEvent()

Returns

CheckInClient

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public CheckInClient IncludeEventPeriod()

Returns

CheckInClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public CheckInClient IncludeEventTimes()

Returns

CheckInClient

IncludeLocations()

Include related Locations resources in the response.

public CheckInClient IncludeLocations()

Returns

CheckInClient

IncludeOptions()

Include related Options resources in the response.

public CheckInClient IncludeOptions()

Returns

CheckInClient

IncludePerson()

Include related Person resources in the response.

public CheckInClient IncludePerson()

Returns

CheckInClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCheckInClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCheckInClient

The current PaginatedCheckInClient instance.

OrderByCheckedOutAt()

Sort response items by the CheckedOutAt attribute.

public CheckInClient OrderByCheckedOutAt()

Returns

CheckInClient

OrderByCheckedOutAtDescending()

Sort response items by the CheckedOutAt attribute. Use reverse order.

public CheckInClient OrderByCheckedOutAtDescending()

Returns

CheckInClient

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public CheckInClient OrderByCreatedAt()

Returns

CheckInClient

OrderByCreatedAtDescending()

Sort response items by the CreatedAt attribute. Use reverse order.

public CheckInClient OrderByCreatedAtDescending()

Returns

CheckInClient

OrderByFirstName()

Sort response items by the FirstName attribute.

public CheckInClient OrderByFirstName()

Returns

CheckInClient

OrderByFirstNameDescending()

Sort response items by the FirstName attribute. Use reverse order.

public CheckInClient OrderByFirstNameDescending()

Returns

CheckInClient

OrderByLastName()

Sort response items by the LastName attribute.

public CheckInClient OrderByLastName()

Returns

CheckInClient

OrderByLastNameDescending()

Sort response items by the LastName attribute. Use reverse order.

public CheckInClient OrderByLastNameDescending()

Returns

CheckInClient

OrderByNumber()

Sort response items by the Number attribute.

public CheckInClient OrderByNumber()

Returns

CheckInClient

OrderByNumberDescending()

Sort response items by the Number attribute. Use reverse order.

public CheckInClient OrderByNumberDescending()

Returns

CheckInClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public CheckInClient OrderByUpdatedAt()

Returns

CheckInClient

OrderByUpdatedAtDescending()

Sort response items by the UpdatedAt attribute. Use reverse order.

public CheckInClient OrderByUpdatedAtDescending()

Returns

CheckInClient

PerPage(int)

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

public PaginatedCheckInClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCheckInClient

The current PaginatedCheckInClient instance.

WhereAccountCenterPersonId(int)

Query response items by the AccountCenterPersonId attribute.

public CheckInClient WhereAccountCenterPersonId(int value)

Parameters

value int

Returns

CheckInClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public CheckInClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

CheckInClient

WhereSecurityCode(string)

Query response items by the SecurityCode attribute.

public CheckInClient WhereSecurityCode(string value)

Parameters

value string

Returns

CheckInClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public CheckInClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

CheckInClient

WithId(string)

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

public CheckInClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CheckInClient

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