Class FormCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_28

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the FormCategory resource.

public class FormCategoryClient : SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>

Inheritance

object

ResourceClient<FormCategory>

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>

FormCategoryClient

Inherited Members

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>.PatchAsync(FormCategory, CancellationToken)

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>.PatchAsync(JsonApiDocument<FormCategoryResource>, CancellationToken)

SingletonResourceClient<FormCategory, FormCategoryResource, FormCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<FormCategory>.AddQueryParameter(string, string)

ResourceClient<FormCategory>.ReplaceQueryParameter(string, string)

ResourceClient<FormCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<FormCategory>.Uri

ResourceClient<FormCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FormCategoryClient(HttpClient, Uri)

Client for interacting with the FormCategory resource.

public FormCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public FormCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

FormCategoryClient

The current FormCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public FormCategoryClient ClearParameters()

Returns

FormCategoryClient

The current FormCategoryClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(FormCategory, CancellationToken)

Updates an existing FormCategory resource asynchronously.

public Task<FormCategoryResponse> PatchAsync(FormCategory resource, CancellationToken cancellationToken = default)

Parameters

resource FormCategory

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<FormCategoryResource>, CancellationToken)

Updates an existing FormCategory resource asynchronously.

public Task<FormCategoryResponse> PatchAsync(JsonApiDocument<FormCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<FormCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FormCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.