Class PersonClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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

Events

Associated Events.

public PaginatedEventClient Events { get; }

Property Value

PaginatedEventClient

Groups

Associated Groups.

public PaginatedGroupClient Groups { get; }

Property Value

PaginatedGroupClient

Memberships

Associated Memberships.

public PaginatedMembershipClient Memberships { get; }

Property Value

PaginatedMembershipClient

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.