Class PlanNoteCategoryClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanNoteCategory resource.

public class PlanNoteCategoryClient : SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>

Inheritance

object

ResourceClient<PlanNoteCategory>

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>

PlanNoteCategoryClient

Inherited Members

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>.PatchAsync(PlanNoteCategory, CancellationToken)

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>.PatchAsync(JsonApiDocument<PlanNoteCategoryResource>, CancellationToken)

SingletonResourceClient<PlanNoteCategory, PlanNoteCategoryResource, PlanNoteCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanNoteCategory>.AddQueryParameter(string, string)

ResourceClient<PlanNoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<PlanNoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanNoteCategory>.Uri

ResourceClient<PlanNoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanNoteCategoryClient(HttpClient, Uri)

Client for interacting with the PlanNoteCategory resource.

public PlanNoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public PlanNoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

PlanNoteCategoryClient

The current PlanNoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public PlanNoteCategoryClient ClearParameters()

Returns

PlanNoteCategoryClient

The current PlanNoteCategoryClient instance.

GetAsync(CancellationToken)

Fetches the PlanNoteCategory resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.