Class PaginatedEventClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2018_08_01

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.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public EventClient OrderByCreatedAt()

Returns

EventClient

OrderByCreatedAtDescending()

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

public EventClient OrderByCreatedAtDescending()

Returns

EventClient

WhereStatus(string)

Query response items by the Status attribute.

public EventClient WhereStatus(string value)

Parameters

value string

Returns

EventClient

WhereUuid(string)

Query response items by the Uuid attribute.

public EventClient WhereUuid(string value)

Parameters

value string

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.