Class EventClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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>.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

Attendances

Associated Attendances.

public PaginatedAttendanceClient Attendances { get; }

Property Value

PaginatedAttendanceClient

Group

Associated Group.

public GroupClient Group { get; }

Property Value

GroupClient

Location

Associated Location.

public LocationClient Location { get; }

Property Value

LocationClient

Notes

Associated Notes.

public PaginatedEventNoteClient Notes { get; }

Property Value

PaginatedEventNoteClient

Rsvps

Associated Rsvps.

public PaginatedRsvpClient Rsvps { get; }

Property Value

PaginatedRsvpClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public EventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

EventClient

The current EventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public EventClient ClearParameters()

Returns

EventClient

The current EventClient instance.

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.

IncludeGroup()

Include related Group resources in the response.

public EventClient IncludeGroup()

Returns

EventClient

IncludeLocation()

Include related Location resources in the response.

public EventClient IncludeLocation()

Returns

EventClient