Class PaginatedLocationClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Location collection resources.

public class PaginatedLocationClient : PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>

Inheritance

object

ResourceClient<Location>

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>

PaginatedLocationClient

Inherited Members

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.PerPage(int)

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.Offset(int)

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.Filter(string)

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.PostAsync(Location, CancellationToken)

PaginatedResourceClient<Location, LocationResource, LocationCollectionResponse, LocationResponse>.PostAsync(JsonApiDocument<LocationResource>, CancellationToken)

ResourceClient<Location>.AddQueryParameter(string, string)

ResourceClient<Location>.ReplaceQueryParameter(string, string)

ResourceClient<Location>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Location>.Uri

ResourceClient<Location>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedLocationClient(HttpClient, Uri)

Client for interacting with Location collection resources.

public PaginatedLocationClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLocationClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLocationClient

The current PaginatedLocationClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLocationClient ClearParameters()

Returns

PaginatedLocationClient

The current PaginatedLocationClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLocationClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLocationClient

The current PaginatedLocationClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of Location resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeEvent()

Include related Event resources in the response.

public LocationClient IncludeEvent()

Returns

LocationClient

IncludeLocations()

Include related Locations resources in the response.

public LocationClient IncludeLocations()

Returns

LocationClient

IncludeOptions()

Include related Options resources in the response.

public LocationClient IncludeOptions()

Returns

LocationClient

IncludeParent()

Include related Parent resources in the response.

public LocationClient IncludeParent()

Returns

LocationClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLocationClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLocationClient

The current PaginatedLocationClient instance.

OrderByKind()

Sort response items by the Kind attribute.

public LocationClient OrderByKind()

Returns

LocationClient

OrderByKindDescending()

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

public LocationClient OrderByKindDescending()

Returns

LocationClient

OrderByName()

Sort response items by the Name attribute.

public LocationClient OrderByName()

Returns

LocationClient

OrderByNameDescending()

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

public LocationClient OrderByNameDescending()

Returns

LocationClient

OrderByPosition()

Sort response items by the Position attribute.

public LocationClient OrderByPosition()

Returns

LocationClient

OrderByPositionDescending()

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

public LocationClient OrderByPositionDescending()

Returns

LocationClient

PerPage(int)

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

public PaginatedLocationClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLocationClient

The current PaginatedLocationClient instance.

WithId(string)

Creates a new instance of a Location client for a specific resource ID.

public LocationClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LocationClient

A new instance of the resource client for the specified resource ID.