Class EventInstanceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the EventInstance resource.

public class EventInstanceClient : SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>

Inheritance

object

ResourceClient<EventInstance>

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>

EventInstanceClient

Inherited Members

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>.GetAsync(CancellationToken)

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>.PatchAsync(EventInstance, CancellationToken)

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>.PatchAsync(JsonApiDocument<EventInstanceResource>, CancellationToken)

SingletonResourceClient<EventInstance, EventInstanceResource, EventInstanceResponse>.DeleteAsync(CancellationToken)

ResourceClient<EventInstance>.AddQueryParameter(string, string)

ResourceClient<EventInstance>.ReplaceQueryParameter(string, string)

ResourceClient<EventInstance>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventInstance>.Uri

ResourceClient<EventInstance>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventInstanceClient(HttpClient, Uri)

Client for interacting with the EventInstance resource.

public EventInstanceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Event

Associated Event.

public EventClient Event { get; }

Property Value

EventClient

EventTimes

Associated EventTimes.

public PaginatedEventTimeClient EventTimes { get; }

Property Value

PaginatedEventTimeClient

ResourceBookings

Associated ResourceBookings.

public PaginatedResourceBookingClient ResourceBookings { get; }

Property Value

PaginatedResourceBookingClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventInstanceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventInstanceClient

The current EventInstanceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventInstanceClient ClearParameters()

Returns

EventInstanceClient

The current EventInstanceClient instance.

GetAsync(CancellationToken)

Fetches the EventInstance resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventInstanceResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventInstanceClient IncludeEvent()

Returns

EventInstanceClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public EventInstanceClient IncludeEventTimes()

Returns

EventInstanceClient

IncludeResourceBookings()

Include related ResourceBookings resources in the response.

public EventInstanceClient IncludeResourceBookings()

Returns

EventInstanceClient

IncludeTags()

Include related Tags resources in the response.

public EventInstanceClient IncludeTags()

Returns

EventInstanceClient