Class PaginatedLocationLabelClient

Namespace

Crews.PlanningCenter.Api.CheckIns.V2024_11_07

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with LocationLabel collection resources.

public class PaginatedLocationLabelClient : PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>

Inheritance

object

ResourceClient<LocationLabel>

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>

PaginatedLocationLabelClient

Inherited Members

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.PerPage(int)

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.Offset(int)

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.Filter(string)

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.PostAsync(LocationLabel, CancellationToken)

PaginatedResourceClient<LocationLabel, LocationLabelResource, LocationLabelCollectionResponse, LocationLabelResponse>.PostAsync(JsonApiDocument<LocationLabelResource>, CancellationToken)

ResourceClient<LocationLabel>.AddQueryParameter(string, string)

ResourceClient<LocationLabel>.ReplaceQueryParameter(string, string)

ResourceClient<LocationLabel>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<LocationLabel>.Uri

ResourceClient<LocationLabel>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedLocationLabelClient(HttpClient, Uri)

Client for interacting with LocationLabel collection resources.

public PaginatedLocationLabelClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PaginatedLocationLabelClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PaginatedLocationLabelClient

The current PaginatedLocationLabelClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PaginatedLocationLabelClient ClearParameters()

Returns

PaginatedLocationLabelClient

The current PaginatedLocationLabelClient instance.

Filter(string)

Adds a filter query parameter to the request.

public PaginatedLocationLabelClient Filter(string filter)

Parameters

filter string

The filter criteria.

Returns

PaginatedLocationLabelClient

The current PaginatedLocationLabelClient instance.

Remarks

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

GetAsync(CancellationToken)

Fetches a paginated list of LocationLabel resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<LocationLabelCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLabel()

Include related Label resources in the response.

public LocationLabelClient IncludeLabel()

Returns

LocationLabelClient

IncludeLocation()

Include related Location resources in the response.

public LocationLabelClient IncludeLocation()

Returns

LocationLabelClient

Offset(int)

Sets the item offset in the paginated response.

public PaginatedLocationLabelClient Offset(int count)

Parameters

count int

The number of items to skip.

Returns

PaginatedLocationLabelClient

The current PaginatedLocationLabelClient instance.

PerPage(int)

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

public PaginatedLocationLabelClient PerPage(int count)

Parameters

count int

The number of items to be returned per page.

Returns

PaginatedLocationLabelClient

The current PaginatedLocationLabelClient instance.

WithId(string)

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

public LocationLabelClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

LocationLabelClient

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