Class PaginatedPersonClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

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.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public PersonClient OrderByCreatedAt()

Returns

PersonClient

OrderByCreatedAtDescending()

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

public PersonClient OrderByCreatedAtDescending()

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

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

OrderByResolvesConflicts()

Sort response items by the ResolvesConflicts attribute.

public PersonClient OrderByResolvesConflicts()

Returns

PersonClient

OrderByResolvesConflictsDescending()

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

public PersonClient OrderByResolvesConflictsDescending()

Returns

PersonClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public PersonClient OrderByUpdatedAt()

Returns

PersonClient

OrderByUpdatedAtDescending()

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

public PersonClient OrderByUpdatedAtDescending()

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.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public PersonClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

PersonClient

WhereFirstName(string)

Query response items by the FirstName attribute.

public PersonClient WhereFirstName(string value)

Parameters

value string

Returns

PersonClient

WhereLastName(string)

Query response items by the LastName attribute.

public PersonClient WhereLastName(string value)

Parameters

value string

Returns

PersonClient

WhereMiddleName(string)

Query response items by the MiddleName attribute.

public PersonClient WhereMiddleName(string value)

Parameters

value string

Returns

PersonClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public PersonClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

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.