Class EventTimeClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

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>.AddCustomParameter(string, string)

ResourceClient<EventTime>.ClearParameters()

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

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

Methods

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