Class PaginatedDeliveryClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2022_10_20

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Delivery collection resources.

public class PaginatedDeliveryClient : PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>

Inheritance

object

ResourceClient<Delivery>

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>

PaginatedDeliveryClient

Inherited Members

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.PerPage(int)

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.Offset(int)

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.Filter(string)

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.PostAsync(Delivery, CancellationToken)

PaginatedResourceClient<Delivery, DeliveryResource, DeliveryCollectionResponse, DeliveryResponse>.PostAsync(JsonApiDocument<DeliveryResource>, CancellationToken)

ResourceClient<Delivery>.AddQueryParameter(string, string)

ResourceClient<Delivery>.ReplaceQueryParameter(string, string)

ResourceClient<Delivery>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Delivery>.Uri

ResourceClient<Delivery>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedDeliveryClient(HttpClient, Uri)

Client for interacting with Delivery collection resources.

public PaginatedDeliveryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedDeliveryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedDeliveryClient

The current PaginatedDeliveryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedDeliveryClient ClearParameters()

Returns

PaginatedDeliveryClient

The current PaginatedDeliveryClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedDeliveryClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedDeliveryClient

The current PaginatedDeliveryClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Delivery resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DeliveryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedDeliveryClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedDeliveryClient

The current PaginatedDeliveryClient instance.

OrderByCreatedAt()

Sort response items by the CreatedAt attribute.

public DeliveryClient OrderByCreatedAt()

Returns

DeliveryClient

OrderByCreatedAtDescending()

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

public DeliveryClient OrderByCreatedAtDescending()

Returns

DeliveryClient

PerPage(int)

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

public PaginatedDeliveryClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedDeliveryClient

The current PaginatedDeliveryClient instance.

WithId(string)

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

public DeliveryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

DeliveryClient

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