Class ItemNoteCategoryClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ItemNoteCategory resource.

public class ItemNoteCategoryClient : SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>

Inheritance

object

ResourceClient<ItemNoteCategory>

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>

ItemNoteCategoryClient

Inherited Members

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>.PatchAsync(ItemNoteCategory, CancellationToken)

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>.PatchAsync(JsonApiDocument<ItemNoteCategoryResource>, CancellationToken)

SingletonResourceClient<ItemNoteCategory, ItemNoteCategoryResource, ItemNoteCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<ItemNoteCategory>.AddQueryParameter(string, string)

ResourceClient<ItemNoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<ItemNoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemNoteCategory>.Uri

ResourceClient<ItemNoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ItemNoteCategoryClient(HttpClient, Uri)

Client for interacting with the ItemNoteCategory resource.

public ItemNoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ItemNoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ItemNoteCategoryClient

The current ItemNoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ItemNoteCategoryClient ClearParameters()

Returns

ItemNoteCategoryClient

The current ItemNoteCategoryClient instance.

GetAsync(CancellationToken)

Fetches the ItemNoteCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.