Class PaginatedAvailableEventClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2022_10_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with AvailableEvent collection resources.

public class PaginatedAvailableEventClient : PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>

Inheritance

object

ResourceClient<AvailableEvent>

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>

PaginatedAvailableEventClient

Inherited Members

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.PerPage(int)

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.Offset(int)

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.Filter(string)

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.PostAsync(AvailableEvent, CancellationToken)

PaginatedResourceClient<AvailableEvent, AvailableEventResource, AvailableEventCollectionResponse, AvailableEventResponse>.PostAsync(JsonApiDocument<AvailableEventResource>, CancellationToken)

ResourceClient<AvailableEvent>.AddQueryParameter(string, string)

ResourceClient<AvailableEvent>.ReplaceQueryParameter(string, string)

ResourceClient<AvailableEvent>.AddCustomParameter(string, string)

ResourceClient<AvailableEvent>.ClearParameters()

ResourceClient<AvailableEvent>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<AvailableEvent>.Uri

ResourceClient<AvailableEvent>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedAvailableEventClient(HttpClient, Uri)

Client for interacting with AvailableEvent collection resources.

public PaginatedAvailableEventClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of AvailableEvent resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<AvailableEventCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.