Class PaginatedEventTimeClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2023_04_05

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

IncludeEventPeriod()

Include related EventPeriod resources in the response.

public EventTimeClient IncludeEventPeriod()

Returns

EventTimeClient

IncludeHeadcounts()

Include related Headcounts resources in the response.

public EventTimeClient IncludeHeadcounts()

Returns

EventTimeClient

OrderByShowsAt()

Sort response items by the ShowsAt attribute.

public EventTimeClient OrderByShowsAt()

Returns

EventTimeClient

OrderByShowsAtDescending()

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

public EventTimeClient OrderByShowsAtDescending()

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

WhereCreatedAt(DateTime)

Query response items by the CreatedAt attribute.

public EventTimeClient WhereCreatedAt(DateTime value)

Parameters

value DateTime

Returns

EventTimeClient

WhereUpdatedAt(DateTime)

Query response items by the UpdatedAt attribute.

public EventTimeClient WhereUpdatedAt(DateTime value)

Parameters

value DateTime

Returns

EventTimeClient

WithId(string)

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

public EventTimeClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventTimeClient

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