Class PaginatedEventTimeClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2022_07_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventTime collection resources.

public class PaginatedEventTimeClient : PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>

Inheritance

object

ResourceClient<EventTime>

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>

PaginatedEventTimeClient

Inherited Members

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.PerPage(int)

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.Offset(int)

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.Filter(string)

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.PostAsync(EventTime, CancellationToken)

PaginatedResourceClient<EventTime, EventTimeResource, EventTimeCollectionResponse, EventTimeResponse>.PostAsync(JsonApiDocument<EventTimeResource>, CancellationToken)

ResourceClient<EventTime>.AddQueryParameter(string, string)

ResourceClient<EventTime>.ReplaceQueryParameter(string, string)

ResourceClient<EventTime>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventTime>.Uri

ResourceClient<EventTime>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventTimeClient(HttpClient, Uri)

Client for interacting with EventTime collection resources.

public PaginatedEventTimeClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedEventTimeClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedEventTimeClient

The current PaginatedEventTimeClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedEventTimeClient ClearParameters()

Returns

PaginatedEventTimeClient

The current PaginatedEventTimeClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedEventTimeClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedEventTimeClient

The current PaginatedEventTimeClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of EventTime resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventTimeCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventTimeClient IncludeEvent()

Returns

EventTimeClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedEventTimeClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedEventTimeClient

The current PaginatedEventTimeClient instance.

OrderByEndsAt()

Sort response items by the EndsAt attribute.

public EventTimeClient OrderByEndsAt()

Returns

EventTimeClient

OrderByEndsAtDescending()

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

public EventTimeClient OrderByEndsAtDescending()

Returns

EventTimeClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public EventTimeClient OrderByStartsAt()

Returns

EventTimeClient

OrderByStartsAtDescending()

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

public EventTimeClient OrderByStartsAtDescending()

Returns

EventTimeClient

PerPage(int)

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

public PaginatedEventTimeClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedEventTimeClient

The current PaginatedEventTimeClient instance.

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public EventTimeClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

EventTimeClient

WhereName(DateTime)

Query response items by the Name attribute.

public EventTimeClient WhereName(DateTime value)

Parameters

value DateTime

Returns

EventTimeClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public EventTimeClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

EventTimeClient

WhereVisibleOnKiosks(bool)

Query response items by the VisibleOnKiosks attribute.

public EventTimeClient WhereVisibleOnKiosks(bool value)

Parameters

value bool

Returns

EventTimeClient

WhereVisibleOnWidgetAndIcal(bool)

Query response items by the VisibleOnWidgetAndIcal attribute.

public EventTimeClient WhereVisibleOnWidgetAndIcal(bool value)

Parameters

value bool

Returns

EventTimeClient