Class CategoryClient

Namespace

Crews.PlanningCenter.Api.Registrations.V2025_05_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Category resource.

public class CategoryClient : SingletonResourceClient<Category, CategoryResource, CategoryResponse>

Inheritance

object

ResourceClient<Category>

SingletonResourceClient<Category, CategoryResource, CategoryResponse>

CategoryClient

Inherited Members

SingletonResourceClient<Category, CategoryResource, CategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Category, CategoryResource, CategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Category, CategoryResource, CategoryResponse>.PatchAsync(Category, CancellationToken)

SingletonResourceClient<Category, CategoryResource, CategoryResponse>.PatchAsync(JsonApiDocument<CategoryResource>, CancellationToken)

SingletonResourceClient<Category, CategoryResource, CategoryResponse>.DeleteAsync(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

CategoryClient(HttpClient, Uri)

Client for interacting with the Category resource.

public CategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

GetAsync(CancellationToken)

Fetches the Category resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<CategoryResponse>

A task representing the asynchronous operation, containing the Category resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.