Class BirthdayPeopleClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the BirthdayPeople resource.

public class BirthdayPeopleClient : SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>

Inheritance

object

ResourceClient<BirthdayPeople>

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>

BirthdayPeopleClient

Inherited Members

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>.GetAsync(CancellationToken)

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>.PatchAsync(BirthdayPeople, CancellationToken)

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>.PatchAsync(JsonApiDocument<BirthdayPeopleResource>, CancellationToken)

SingletonResourceClient<BirthdayPeople, BirthdayPeopleResource, BirthdayPeopleResponse>.DeleteAsync(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

BirthdayPeopleClient(HttpClient, Uri)

Client for interacting with the BirthdayPeople resource.

public BirthdayPeopleClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the BirthdayPeople resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<BirthdayPeopleResponse>

A task representing the asynchronous operation, containing the BirthdayPeople resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.