Class PaginatedEventClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

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.

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

WhereApprovalStatus(string)

Query response items by the ApprovalStatus attribute.

public EventClient WhereApprovalStatus(string value)

Parameters

value string

Returns

EventClient

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public EventClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

EventClient

WhereFeatured(bool)

Query response items by the Featured attribute.

public EventClient WhereFeatured(bool value)

Parameters

value bool

Returns

EventClient

WhereName(string)

Query response items by the Name attribute.

public EventClient WhereName(string value)

Parameters

value string

Returns

EventClient

WherePercentApproved(int)

Query response items by the PercentApproved attribute.

public EventClient WherePercentApproved(int value)

Parameters

value int

Returns

EventClient

WherePercentRejected(int)

Query response items by the PercentRejected attribute.

public EventClient WherePercentRejected(int value)

Parameters

value int

Returns

EventClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public EventClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

EventClient

WhereVisibleInChurchCenter(bool)

Query response items by the VisibleInChurchCenter attribute.

public EventClient WhereVisibleInChurchCenter(bool value)

Parameters

value bool

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.