Class WorkflowCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowCategory resource.

public class WorkflowCategoryClient : SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>

Inheritance

object

ResourceClient<WorkflowCategory>

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>

WorkflowCategoryClient

Inherited Members

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>.PatchAsync(WorkflowCategory, CancellationToken)

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>.PatchAsync(JsonApiDocument<WorkflowCategoryResource>, CancellationToken)

SingletonResourceClient<WorkflowCategory, WorkflowCategoryResource, WorkflowCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowCategory>.AddQueryParameter(string, string)

ResourceClient<WorkflowCategory>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCategory>.Uri

ResourceClient<WorkflowCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowCategoryClient(HttpClient, Uri)

Client for interacting with the WorkflowCategory resource.

public WorkflowCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowCategoryClient

The current WorkflowCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowCategoryClient ClearParameters()

Returns

WorkflowCategoryClient

The current WorkflowCategoryClient instance.

DeleteAsync(CancellationToken)

Deletes the WorkflowCategory 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 WorkflowCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(WorkflowCategory, CancellationToken)

Updates an existing WorkflowCategory resource asynchronously.

public Task<WorkflowCategoryResponse> PatchAsync(WorkflowCategory resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowCategory

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<WorkflowCategoryResource>, CancellationToken)

Updates an existing WorkflowCategory resource asynchronously.

public Task<WorkflowCategoryResponse> PatchAsync(JsonApiDocument<WorkflowCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.