Class NoteCategoryClient

Namespace

Crews.PlanningCenter.Api.People.V2020_04_06

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the NoteCategory resource.

public class NoteCategoryClient : SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>

Inheritance

object

ResourceClient<NoteCategory>

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>

NoteCategoryClient

Inherited Members

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>.GetAsync(CancellationToken)

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>.PatchAsync(NoteCategory, CancellationToken)

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>.PatchAsync(JsonApiDocument<NoteCategoryResource>, CancellationToken)

SingletonResourceClient<NoteCategory, NoteCategoryResource, NoteCategoryResponse>.DeleteAsync(CancellationToken)

ResourceClient<NoteCategory>.AddQueryParameter(string, string)

ResourceClient<NoteCategory>.ReplaceQueryParameter(string, string)

ResourceClient<NoteCategory>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteCategory>.Uri

ResourceClient<NoteCategory>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NoteCategoryClient(HttpClient, Uri)

Client for interacting with the NoteCategory resource.

public NoteCategoryClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Shares

Associated Shares.

public PaginatedNoteCategoryShareClient Shares { get; }

Property Value

PaginatedNoteCategoryShareClient

Subscribers

Associated Subscribers.

public PaginatedPersonClient Subscribers { get; }

Property Value

PaginatedPersonClient

Subscriptions

Associated Subscriptions.

public PaginatedNoteCategorySubscriptionClient Subscriptions { get; }

Property Value

PaginatedNoteCategorySubscriptionClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public NoteCategoryClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

NoteCategoryClient

The current NoteCategoryClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public NoteCategoryClient ClearParameters()

Returns

NoteCategoryClient

The current NoteCategoryClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeShares()

Include related Shares resources in the response.

public NoteCategoryClient IncludeShares()

Returns

NoteCategoryClient

IncludeSubscribers()

Include related Subscribers resources in the response.

public NoteCategoryClient IncludeSubscribers()

Returns

NoteCategoryClient

IncludeSubscriptions()

Include related Subscriptions resources in the response.

public NoteCategoryClient IncludeSubscriptions()

Returns

NoteCategoryClient

PatchAsync(NoteCategory, CancellationToken)

Updates an existing NoteCategory resource asynchronously.

public Task<NoteCategoryResponse> PatchAsync(NoteCategory resource, CancellationToken cancellationToken = default)

Parameters

resource NoteCategory

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<NoteCategoryResource>, CancellationToken)

Updates an existing NoteCategory resource asynchronously.

public Task<NoteCategoryResponse> PatchAsync(JsonApiDocument<NoteCategoryResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteCategoryResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.