Class DeliveryClient

Namespace

Crews.PlanningCenter.Api.Webhooks.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Delivery resource.

public class DeliveryClient : SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>

Inheritance

object

ResourceClient<Delivery>

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>

DeliveryClient

Inherited Members

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>.PatchAsync(Delivery, CancellationToken)

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>.PatchAsync(JsonApiDocument<DeliveryResource>, CancellationToken)

SingletonResourceClient<Delivery, DeliveryResource, DeliveryResponse>.DeleteAsync(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

DeliveryClient(HttpClient, Uri)

Client for interacting with the Delivery resource.

public DeliveryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public DeliveryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

DeliveryClient

The current DeliveryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public DeliveryClient ClearParameters()

Returns

DeliveryClient

The current DeliveryClient instance.

GetAsync(CancellationToken)

Fetches the Delivery resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<DeliveryResponse>

A task representing the asynchronous operation, containing the Delivery resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.