Class PaginatedLocationClient

Namespace

Crews.PlanningCenter.Api.Groups.V2023_07_10

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>.AddCustomParameter(string, string)

ResourceClient<Location>.ClearParameters()

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

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.

IncludeGroup()

Include related Group resources in the response.

public LocationClient IncludeGroup()

Returns

LocationClient

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.