Class PaginatedAvailableEventClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2018_08_01

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedAvailableEventClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedAvailableEventClient

The current PaginatedAvailableEventClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedAvailableEventClient ClearParameters()

Returns

PaginatedAvailableEventClient

The current PaginatedAvailableEventClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedAvailableEventClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedAvailableEventClient

The current PaginatedAvailableEventClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedAvailableEventClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedAvailableEventClient

The current PaginatedAvailableEventClient instance.

PerPage(int)

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

public PaginatedAvailableEventClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedAvailableEventClient

The current PaginatedAvailableEventClient instance.