Class PaginatedEventInstanceClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventInstance collection resources.

public class PaginatedEventInstanceClient : PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>

Inheritance

object

ResourceClient<EventInstance>

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>

PaginatedEventInstanceClient

Inherited Members

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.PerPage(int)

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.Offset(int)

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.Filter(string)

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.PostAsync(EventInstance, CancellationToken)

PaginatedResourceClient<EventInstance, EventInstanceResource, EventInstanceCollectionResponse, EventInstanceResponse>.PostAsync(JsonApiDocument<EventInstanceResource>, CancellationToken)

ResourceClient<EventInstance>.AddQueryParameter(string, string)

ResourceClient<EventInstance>.ReplaceQueryParameter(string, string)

ResourceClient<EventInstance>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventInstance>.Uri

ResourceClient<EventInstance>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventInstanceClient(HttpClient, Uri)

Client for interacting with EventInstance collection resources.

public PaginatedEventInstanceClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventInstanceClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventInstanceClient

The current PaginatedEventInstanceClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventInstanceClient ClearParameters()

Returns

PaginatedEventInstanceClient

The current PaginatedEventInstanceClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventInstanceClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventInstanceClient

The current PaginatedEventInstanceClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EventInstance resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventInstanceCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventInstanceClient IncludeEvent()

Returns

EventInstanceClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public EventInstanceClient IncludeEventTimes()

Returns

EventInstanceClient

IncludeResourceBookings()

Include related ResourceBookings resources in the response.

public EventInstanceClient IncludeResourceBookings()

Returns

EventInstanceClient

IncludeTags()

Include related Tags resources in the response.

public EventInstanceClient IncludeTags()

Returns

EventInstanceClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventInstanceClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventInstanceClient

The current PaginatedEventInstanceClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public EventInstanceClient OrderByCreatedAt()

Returns

EventInstanceClient

OrderByCreatedAtDescending()

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

public EventInstanceClient OrderByCreatedAtDescending()

Returns

EventInstanceClient

OrderByEndsAt()

Sort response items by the EndsAt attribute.

public EventInstanceClient OrderByEndsAt()

Returns

EventInstanceClient

OrderByEndsAtDescending()

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

public EventInstanceClient OrderByEndsAtDescending()

Returns

EventInstanceClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public EventInstanceClient OrderByStartsAt()

Returns

EventInstanceClient

OrderByStartsAtDescending()

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

public EventInstanceClient OrderByStartsAtDescending()

Returns

EventInstanceClient

OrderByUpdatedAt()

Sort response items by the UpdatedAt attribute.

public EventInstanceClient OrderByUpdatedAt()

Returns

EventInstanceClient

OrderByUpdatedAtDescending()

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

public EventInstanceClient OrderByUpdatedAtDescending()

Returns

EventInstanceClient

PerPage(int)

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

public PaginatedEventInstanceClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventInstanceClient

The current PaginatedEventInstanceClient instance.

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public EventInstanceClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

EventInstanceClient

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public EventInstanceClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

EventInstanceClient

WhereKind(string)

Query response items by the Kind attribute.

public EventInstanceClient WhereKind(string value)

Parameters

value string

Returns

EventInstanceClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public EventInstanceClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

EventInstanceClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public EventInstanceClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

EventInstanceClient

WithId(string)

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

public EventInstanceClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventInstanceClient

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