Class PersonClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Person resource.

public class PersonClient : SingletonResourceClient<Person, PersonResource, PersonResponse>

Inheritance

object

ResourceClient<Person>

SingletonResourceClient<Person, PersonResource, PersonResponse>

PersonClient

Inherited Members

SingletonResourceClient<Person, PersonResource, PersonResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(Person, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.PatchAsync(JsonApiDocument<PersonResource>, CancellationToken)

SingletonResourceClient<Person, PersonResource, PersonResponse>.DeleteAsync(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

PersonClient(HttpClient, Uri)

Client for interacting with the Person resource.

public PersonClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

Organization

Associated Organization.

public OrganizationClient Organization { get; }

Property Value

OrganizationClient

Passes

Associated Passes.

public PaginatedPassClient Passes { get; }

Property Value

PaginatedPassClient

PersonEvents

Associated PersonEvents.

public PaginatedPersonEventClient PersonEvents { get; }

Property Value

PaginatedPersonEventClient

Methods

GetAsync(CancellationToken)

Fetches the Person resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeOrganization()

Include related Organization resources in the response.

public PersonClient IncludeOrganization()

Returns

PersonClient