Class PaginatedEventPeriodClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_09_03

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with EventPeriod collection resources.

public class PaginatedEventPeriodClient : PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>

Inheritance

object

ResourceClient<EventPeriod>

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>

PaginatedEventPeriodClient

Inherited Members

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.PerPage(int)

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.Offset(int)

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.Filter(string)

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.PostAsync(EventPeriod, CancellationToken)

PaginatedResourceClient<EventPeriod, EventPeriodResource, EventPeriodCollectionResponse, EventPeriodResponse>.PostAsync(JsonApiDocument<EventPeriodResource>, CancellationToken)

ResourceClient<EventPeriod>.AddQueryParameter(string, string)

ResourceClient<EventPeriod>.ReplaceQueryParameter(string, string)

ResourceClient<EventPeriod>.AddCustomParameter(string, string)

ResourceClient<EventPeriod>.ClearParameters()

ResourceClient<EventPeriod>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<EventPeriod>.Uri

ResourceClient<EventPeriod>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedEventPeriodClient(HttpClient, Uri)

Client for interacting with EventPeriod collection resources.

public PaginatedEventPeriodClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of EventPeriod resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<EventPeriodCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public EventPeriodClient IncludeEvent()

Returns

EventPeriodClient

IncludeEventTimes()

Include related EventTimes resources in the response.

public EventPeriodClient IncludeEventTimes()

Returns

EventPeriodClient

OrderByStartsAt()

Sort response items by the StartsAt attribute.

public EventPeriodClient OrderByStartsAt()

Returns

EventPeriodClient

OrderByStartsAtDescending()

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

public EventPeriodClient OrderByStartsAtDescending()

Returns

EventPeriodClient

WhereEndsAt(DateTime)

Query response items by the EndsAt attribute.

public EventPeriodClient WhereEndsAt(DateTime value)

Parameters

value DateTime

Returns

EventPeriodClient

WhereStartsAt(DateTime)

Query response items by the StartsAt attribute.

public EventPeriodClient WhereStartsAt(DateTime value)

Parameters

value DateTime

Returns

EventPeriodClient

WithId(string)

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

public EventPeriodClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

EventPeriodClient

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