Class PaginatedBirthdayPeopleClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedBirthdayPeopleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedBirthdayPeopleClient

The current PaginatedBirthdayPeopleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedBirthdayPeopleClient ClearParameters()

Returns

PaginatedBirthdayPeopleClient

The current PaginatedBirthdayPeopleClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedBirthdayPeopleClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedBirthdayPeopleClient

The current PaginatedBirthdayPeopleClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedBirthdayPeopleClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedBirthdayPeopleClient

The current PaginatedBirthdayPeopleClient instance.

PerPage(int)

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

public PaginatedBirthdayPeopleClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedBirthdayPeopleClient

The current PaginatedBirthdayPeopleClient instance.