Class PaginatedEventClient

Namespace

Crews.PlanningCenter.Api.Groups.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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventClient

The current PaginatedEventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventClient ClearParameters()

Returns

PaginatedEventClient

The current PaginatedEventClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventClient

The current PaginatedEventClient instance.

Remarks

See Planning Center API documentation for details on supported filter values for this resource.

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

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventClient

The current PaginatedEventClient instance.

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

PerPage(int)

Sets the number of items to be returned per page in the paginated response.

public PaginatedEventClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventClient

The current PaginatedEventClient instance.

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.