Class PaginatedCarrierClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

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>.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

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedCarrierClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedCarrierClient

The current PaginatedCarrierClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedCarrierClient ClearParameters()

Returns

PaginatedCarrierClient

The current PaginatedCarrierClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedCarrierClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedCarrierClient

The current PaginatedCarrierClient instance.

Remarks

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

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.

Offset(int)

Sets the item offset in the paginated response.

public PaginatedCarrierClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedCarrierClient

The current PaginatedCarrierClient instance.

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

PerPage(int)

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

public PaginatedCarrierClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedCarrierClient

The current PaginatedCarrierClient instance.