Class PaginatedBirthdayPeopleClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with BirthdayPeople collection resources.

public class PaginatedBirthdayPeopleClient : PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>

Inheritance

object

ResourceClient<BirthdayPeople>

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>

PaginatedBirthdayPeopleClient

Inherited Members

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.PerPage(int)

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.Offset(int)

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.Filter(string)

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.PostAsync(BirthdayPeople, CancellationToken)

PaginatedResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleCollectionResponse, BirthdayPeopleResponse>.PostAsync(JsonApiDocument<BirthdayPeopleResource>, CancellationToken)

ResourceClient<BirthdayPeople>.AddQueryParameter(string, string)

ResourceClient<BirthdayPeople>.ReplaceQueryParameter(string, string)

ResourceClient<BirthdayPeople>.AddCustomParameter(string, string)

ResourceClient<BirthdayPeople>.ClearParameters()

ResourceClient<BirthdayPeople>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<BirthdayPeople>.Uri

ResourceClient<BirthdayPeople>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedBirthdayPeopleClient(HttpClient, Uri)

Client for interacting with BirthdayPeople collection resources.

public PaginatedBirthdayPeopleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of BirthdayPeople resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BirthdayPeopleCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.