Class PaginatedPersonClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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>.AddCustomParameter(string, string)

ResourceClient<Person>.ClearParameters()

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

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.

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

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

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.