Class EventClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Event resource.

public class EventClient : SingletonResourceClient<Event, EventResource, EventResponse>

Inheritance

object

ResourceClient<Event>

SingletonResourceClient<Event, EventResource, EventResponse>

EventClient

Inherited Members

SingletonResourceClient<Event, EventResource, EventResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Event, EventResource, EventResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Event, EventResource, EventResponse>.PatchAsync(Event, CancellationToken)

SingletonResourceClient<Event, EventResource, EventResponse>.PatchAsync(JsonApiDocument<EventResource>, CancellationToken)

SingletonResourceClient<Event, EventResource, EventResponse>.DeleteAsync(CancellationToken)

ResourceClient<Event>.AddQueryParameter(string, string)

ResourceClient<Event>.ReplaceQueryParameter(string, string)

ResourceClient<Event>.AddCustomParameter(string, string)

ResourceClient<Event>.ClearParameters()

ResourceClient<Event>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Event>.Uri

ResourceClient<Event>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

EventClient(HttpClient, Uri)

Client for interacting with the Event resource.

public EventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Attachments

Associated Attachments.

public PaginatedAttachmentClient Attachments { get; }

Property Value

PaginatedAttachmentClient

Conflicts

Associated Conflicts.

public PaginatedConflictClient Conflicts { get; }

Property Value

PaginatedConflictClient

EventConnections

Associated EventConnections.

public PaginatedEventConnectionClient EventConnections { get; }

Property Value

PaginatedEventConnectionClient

EventInstances

Associated EventInstances.

public PaginatedEventInstanceClient EventInstances { get; }

Property Value

PaginatedEventInstanceClient

EventResourceRequests

Associated EventResourceRequests.

public PaginatedEventResourceRequestClient EventResourceRequests { get; }

Property Value

PaginatedEventResourceRequestClient

Feed

Associated Feed.

public FeedClient Feed { get; }

Property Value

FeedClient

Owner

Associated Owner.

public PersonClient Owner { get; }

Property Value

PersonClient

ResourceBookings

Associated ResourceBookings.

public PaginatedResourceBookingClient ResourceBookings { get; }

Property Value

PaginatedResourceBookingClient

Tags

Associated Tags.

public PaginatedTagClient Tags { get; }

Property Value

PaginatedTagClient

Methods

GetAsync(CancellationToken)

Fetches the Event resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeAttachments()

Include related Attachments resources in the response.

public EventClient IncludeAttachments()

Returns

EventClient

IncludeFeed()

Include related Feed resources in the response.

public EventClient IncludeFeed()

Returns

EventClient

IncludeOwner()

Include related Owner resources in the response.

public EventClient IncludeOwner()

Returns

EventClient

IncludeTags()

Include related Tags resources in the response.

public EventClient IncludeTags()

Returns

EventClient