Class PaginatedCategoryClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with Category collection resources.

public class PaginatedCategoryClient : PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>

Inheritance

object

ResourceClient<Category>

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>

PaginatedCategoryClient

Inherited Members

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.PerPage(int)

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.Offset(int)

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.Filter(string)

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.GetAsync(CancellationToken)

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.PostAsync(Category, CancellationToken)

PaginatedResourceClient<Category, CategoryResource, CategoryCollectionResponse, CategoryResponse>.PostAsync(JsonApiDocument<CategoryResource>, CancellationToken)

ResourceClient<Category>.AddQueryParameter(string, string)

ResourceClient<Category>.ReplaceQueryParameter(string, string)

ResourceClient<Category>.AddCustomParameter(string, string)

ResourceClient<Category>.ClearParameters()

ResourceClient<Category>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Category>.Uri

ResourceClient<Category>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PaginatedCategoryClient(HttpClient, Uri)

Client for interacting with Category collection resources.

public PaginatedCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches a paginated list of Category resources asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CategoryCollectionResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

WithId(string)

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

public CategoryClient WithId(string id)

Parameters

id string

The ID of the resource to create a client for.

Returns

CategoryClient

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