Class EventTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventTime resource.

public class EventTimeClient : SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>

Inheritance

object

ResourceClient<EventTime>

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>

EventTimeClient

Inherited Members

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>.PatchAsync(EventTime, CancellationToken)

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>.PatchAsync(JsonApiDocument<EventTimeResource>, CancellationToken)

SingletonResourceClient<EventTime, EventTimeResource, EventTimeResponse>.DeleteAsync(CancellationToken)

ResourceClient<EventTime>.AddQueryParameter(string, string)

ResourceClient<EventTime>.ReplaceQueryParameter(string, string)

ResourceClient<EventTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventTime>.Uri

ResourceClient<EventTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventTimeClient(HttpClient, Uri)

Client for interacting with the EventTime resource.

public EventTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AvailableLocations

Associated AvailableLocations.

public PaginatedLocationClient AvailableLocations { get; }

Property Value

PaginatedLocationClient

CheckIns

Associated CheckIns.

public PaginatedCheckInClient CheckIns { get; }

Property Value

PaginatedCheckInClient

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

EventPeriod

Associated EventPeriod.

public EventPeriodClient EventPeriod { get; }

Property Value

EventPeriodClient

Headcounts

Associated Headcounts.

public PaginatedHeadcountClient Headcounts { get; }

Property Value

PaginatedHeadcountClient

LocationEventTimes

Associated LocationEventTimes.

public PaginatedLocationEventTimeClient LocationEventTimes { get; }

Property Value

PaginatedLocationEventTimeClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventTimeClient

The current EventTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventTimeClient ClearParameters()

Returns

EventTimeClient

The current EventTimeClient instance.

GetAsync(CancellationToken)

Fetches the EventTime resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventTimeResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventTimeClient IncludeEvent()

Returns

EventTimeClient

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public EventTimeClient IncludeEventPeriod()

Returns

EventTimeClient

IncludeHeadcounts()

Include related Headcounts resources in the response.

public EventTimeClient IncludeHeadcounts()

Returns

EventTimeClient