Table of Contents

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
PaginatedDeliveryClient
Inherited Members

Constructors

PaginatedDeliveryClient(HttpClient, Uri)

Client for interacting with Delivery collection resources.

public PaginatedDeliveryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient
uri Uri

Methods

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.

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

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.

Edit this page