Class ListCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2022_07_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ListCategory resource.

public class ListCategoryClient : SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>

Inheritance

object

ResourceClient<ListCategory>

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>

ListCategoryClient

Inherited Members

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>.PatchAsync(ListCategory, CancellationToken)

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>.PatchAsync(JsonApiDocument<ListCategoryResource>, CancellationToken)

SingletonResourceClient<ListCategory, ListCategoryResource, ListCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<ListCategory>.AddQueryParameter(string, string)

ResourceClient<ListCategory>.ReplaceQueryParameter(string, string)

ResourceClient<ListCategory>.AddCustomParameter(string, string)

ResourceClient<ListCategory>.ClearParameters()

ResourceClient<ListCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ListCategory>.Uri

ResourceClient<ListCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ListCategoryClient(HttpClient, Uri)

Client for interacting with the ListCategory resource.

public ListCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Lists

Associated Lists.

public PaginatedListClient Lists { get; }

Property Value

PaginatedListClient

Methods

DeleteAsync(CancellationToken)

Deletes the ListCategory resource asynchronously.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task representing the asynchronous delete operation.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GetAsync(CancellationToken)

Fetches the ListCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeLists()

Include related Lists resources in the response.

public ListCategoryClient IncludeLists()

Returns

ListCategoryClient

PatchAsync(ListCategory, CancellationToken)

Updates an existing ListCategory resource asynchronously.

public Task<ListCategoryResponse> PatchAsync(ListCategory resource, CancellationToken cancellationToken = default)

Parameters

resource ListCategory

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryResponse>

A task representing the asynchronous operation, containing the updated ListCategory resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ListCategoryResource>, CancellationToken)

Updates an existing ListCategory resource asynchronously.

public Task<ListCategoryResponse> PatchAsync(JsonApiDocument<ListCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ListCategoryResource>

The JSON:API document to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ListCategoryResponse>

A task representing the asynchronous operation, containing the updated ListCategory resource.

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.