Class CarrierClient

Namespace

Crews.PlanningCenter.Api.People.V2022_07_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Carrier resource.

public class CarrierClient : SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>

Inheritance

object

ResourceClient<Carrier>

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>

CarrierClient

Inherited Members

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>.PatchAsync(Carrier, CancellationToken)

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>.PatchAsync(JsonApiDocument<CarrierResource>, CancellationToken)

SingletonResourceClient<Carrier, CarrierResource, CarrierResponse>.DeleteAsync(CancellationToken)

ResourceClient<Carrier>.AddQueryParameter(string, string)

ResourceClient<Carrier>.ReplaceQueryParameter(string, string)

ResourceClient<Carrier>.AddCustomParameter(string, string)

ResourceClient<Carrier>.ClearParameters()

ResourceClient<Carrier>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Carrier>.Uri

ResourceClient<Carrier>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CarrierClient(HttpClient, Uri)

Client for interacting with the Carrier resource.

public CarrierClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the Carrier resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CarrierResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.