Class PersonEventClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PersonEvent resource.

public class PersonEventClient : SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>

Inheritance

object

ResourceClient<PersonEvent>

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>

PersonEventClient

Inherited Members

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>.PatchAsync(PersonEvent, CancellationToken)

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>.PatchAsync(JsonApiDocument<PersonEventResource>, CancellationToken)

SingletonResourceClient<PersonEvent, PersonEventResource, PersonEventResponse>.DeleteAsync(CancellationToken)

ResourceClient<PersonEvent>.AddQueryParameter(string, string)

ResourceClient<PersonEvent>.ReplaceQueryParameter(string, string)

ResourceClient<PersonEvent>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PersonEvent>.Uri

ResourceClient<PersonEvent>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PersonEventClient(HttpClient, Uri)

Client for interacting with the PersonEvent resource.

public PersonEventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

FirstCheckIn

Associated FirstCheckIn.

public CheckInClient FirstCheckIn { get; }

Property Value

CheckInClient

LastCheckIn

Associated LastCheckIn.

public CheckInClient LastCheckIn { get; }

Property Value

CheckInClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PersonEventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PersonEventClient

The current PersonEventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PersonEventClient ClearParameters()

Returns

PersonEventClient

The current PersonEventClient instance.

GetAsync(CancellationToken)

Fetches the PersonEvent resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PersonEventResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public PersonEventClient IncludeEvent()

Returns

PersonEventClient

IncludeFirstCheckIn()

Include related FirstCheckIn resources in the response.

public PersonEventClient IncludeFirstCheckIn()

Returns

PersonEventClient

IncludeLastCheckIn()

Include related LastCheckIn resources in the response.

public PersonEventClient IncludeLastCheckIn()

Returns

PersonEventClient

IncludePerson()

Include related Person resources in the response.

public PersonEventClient IncludePerson()

Returns

PersonEventClient