Class BirthdayPeopleClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public BirthdayPeopleClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

BirthdayPeopleClient

The current BirthdayPeopleClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public BirthdayPeopleClient ClearParameters()

Returns

BirthdayPeopleClient

The current BirthdayPeopleClient instance.

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.