Class PaginatedPersonEventClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with PersonEvent collection resources.

public class PaginatedPersonEventClient : PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>

Inheritance

object

ResourceClient<PersonEvent>

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>

PaginatedPersonEventClient

Inherited Members

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.PerPage(int)

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.Offset(int)

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.Filter(string)

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.PostAsync(PersonEvent, CancellationToken)

PaginatedResourceClient<PersonEvent, PersonEventResource, PersonEventCollectionResponse, PersonEventResponse>.PostAsync(JsonApiDocument<PersonEventResource>, CancellationToken)

ResourceClient<PersonEvent>.AddQueryParameter(string, string)

ResourceClient<PersonEvent>.ReplaceQueryParameter(string, string)

ResourceClient<PersonEvent>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonEvent>.Uri

ResourceClient<PersonEvent>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPersonEventClient(HttpClient, Uri)

Client for interacting with PersonEvent collection resources.

public PaginatedPersonEventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPersonEventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPersonEventClient

The current PaginatedPersonEventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPersonEventClient ClearParameters()

Returns

PaginatedPersonEventClient

The current PaginatedPersonEventClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPersonEventClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPersonEventClient

The current PaginatedPersonEventClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of PersonEvent resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonEventCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public PersonEventClient IncludeEvent()

Returns

PersonEventClient

IncludeFirstCheckIn()

Include related FirstCheckIn resources in the response.

public PersonEventClient IncludeFirstCheckIn()

Returns

PersonEventClient

IncludeLastCheckIn()

Include related LastCheckIn resources in the response.

public PersonEventClient IncludeLastCheckIn()

Returns

PersonEventClient

IncludePerson()

Include related Person resources in the response.

public PersonEventClient IncludePerson()

Returns

PersonEventClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPersonEventClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPersonEventClient

The current PaginatedPersonEventClient instance.

PerPage(int)

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

public PaginatedPersonEventClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPersonEventClient

The current PaginatedPersonEventClient instance.

WithId(string)

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

public PersonEventClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonEventClient

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