Class PaginatedEventTimeClient

Namespace

Crews.PlanningCenter.Api.Calendar.V2021_07_20

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>.AddCustomParameter(string, string)

ResourceClient<EventTime>.ClearParameters()

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

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

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

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