Class PaginatedEventClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Event collection resources.

public class PaginatedEventClient : PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>

Inheritance

object

ResourceClient<Event>

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>

PaginatedEventClient

Inherited Members

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.PerPage(int)

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.Offset(int)

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.Filter(string)

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.PostAsync(Event, CancellationToken)

PaginatedResourceClient<Event, EventResource, EventCollectionResponse, EventResponse>.PostAsync(JsonApiDocument<EventResource>, 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

PaginatedEventClient(HttpClient, Uri)

Client for interacting with Event collection resources.

public PaginatedEventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Event resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventCollectionResponse>

A task representing the asynchronous operation, containing a paginated list of Event resources.

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

OrderByEndsAt()

Sort response items by the EndsAt attribute.

public EventClient OrderByEndsAt()

Returns

EventClient

OrderByEndsAtDescending()

Sort response items by the EndsAt attribute. Use reverse order.

public EventClient OrderByEndsAtDescending()

Returns

EventClient

OrderByName()

Sort response items by the Name attribute.

public EventClient OrderByName()

Returns

EventClient

OrderByNameDescending()

Sort response items by the Name attribute. Use reverse order.

public EventClient OrderByNameDescending()

Returns

EventClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public EventClient OrderByStartsAt()

Returns

EventClient

OrderByStartsAtDescending()

Sort response items by the StartsAt attribute. Use reverse order.

public EventClient OrderByStartsAtDescending()

Returns

EventClient

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public EventClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

EventClient

WhereName(string)

Query response items by the Name attribute.

public EventClient WhereName(string value)

Parameters

value string

Returns

EventClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public EventClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

EventClient

WithId(string)

Creates a new instance of a Event client for a specific resource ID.

public EventClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventClient

A new instance of the resource client for the specified resource ID.