Class PaginatedPersonClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Person collection resources.

public class PaginatedPersonClient : PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>

Inheritance

object

ResourceClient<Person>

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>

PaginatedPersonClient

Inherited Members

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.PerPage(int)

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.Offset(int)

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.Filter(string)

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.PostAsync(Person, CancellationToken)

PaginatedResourceClient<Person, PersonResource, PersonCollectionResponse, PersonResponse>.PostAsync(JsonApiDocument<PersonResource>, CancellationToken)

ResourceClient<Person>.AddQueryParameter(string, string)

ResourceClient<Person>.ReplaceQueryParameter(string, string)

ResourceClient<Person>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Person>.Uri

ResourceClient<Person>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedPersonClient(HttpClient, Uri)

Client for interacting with Person collection resources.

public PaginatedPersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedPersonClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedPersonClient

The current PaginatedPersonClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedPersonClient ClearParameters()

Returns

PaginatedPersonClient

The current PaginatedPersonClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedPersonClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedPersonClient

The current PaginatedPersonClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Person resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOrganization()

Include related Organization resources in the response.

public PersonClient IncludeOrganization()

Returns

PersonClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedPersonClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedPersonClient

The current PaginatedPersonClient instance.

OrderByCheckInCount()

Sort response items by the CheckInCount attribute.

public PersonClient OrderByCheckInCount()

Returns

PersonClient

OrderByCheckInCountDescending()

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

public PersonClient OrderByCheckInCountDescending()

Returns

PersonClient

OrderByFirstName()

Sort response items by the FirstName attribute.

public PersonClient OrderByFirstName()

Returns

PersonClient

OrderByFirstNameDescending()

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

public PersonClient OrderByFirstNameDescending()

Returns

PersonClient

OrderByLastCheckedInAt()

Sort response items by the LastCheckedInAt attribute.

public PersonClient OrderByLastCheckedInAt()

Returns

PersonClient

OrderByLastCheckedInAtDescending()

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

public PersonClient OrderByLastCheckedInAtDescending()

Returns

PersonClient

OrderByLastName()

Sort response items by the LastName attribute.

public PersonClient OrderByLastName()

Returns

PersonClient

OrderByLastNameDescending()

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

public PersonClient OrderByLastNameDescending()

Returns

PersonClient

PerPage(int)

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

public PaginatedPersonClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedPersonClient

The current PaginatedPersonClient instance.

WhereHeadcounter(bool)

Query response items by the Headcounter attribute.

public PersonClient WhereHeadcounter(bool value)

Parameters

value bool

Returns

PersonClient

WhereIgnoreFilters(bool)

Query response items by the IgnoreFilters attribute.

public PersonClient WhereIgnoreFilters(bool value)

Parameters

value bool

Returns

PersonClient

WherePermission(string)

Query response items by the Permission attribute.

public PersonClient WherePermission(string value)

Parameters

value string

Returns

PersonClient

WhereSearchName(string)

Query response items by the SearchName attribute.

public PersonClient WhereSearchName(string value)

Parameters

value string

Returns

PersonClient

WithId(string)

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

public PersonClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

PersonClient

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