Class PaginatedCarrierClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Carrier collection resources.

public class PaginatedCarrierClient : PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>

Inheritance

object

ResourceClient<Carrier>

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>

PaginatedCarrierClient

Inherited Members

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.PerPage(int)

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.Offset(int)

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.Filter(string)

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.PostAsync(Carrier, CancellationToken)

PaginatedResourceClient<Carrier, CarrierResource, CarrierCollectionResponse, CarrierResponse>.PostAsync(JsonApiDocument<CarrierResource>, 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

PaginatedCarrierClient(HttpClient, Uri)

Client for interacting with Carrier collection resources.

public PaginatedCarrierClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Carrier resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CarrierCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

OrderByInternational()

Sort response items by the International attribute.

public CarrierClient OrderByInternational()

Returns

CarrierClient

OrderByInternationalDescending()

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

public CarrierClient OrderByInternationalDescending()

Returns

CarrierClient

OrderByName()

Sort response items by the Name attribute.

public CarrierClient OrderByName()

Returns

CarrierClient

OrderByNameDescending()

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

public CarrierClient OrderByNameDescending()

Returns

CarrierClient