Class NoteCategoryShareClient

Namespace

Crews.PlanningCenter.Api.People.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the NoteCategoryShare resource.

public class NoteCategoryShareClient : SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>

Inheritance

object

ResourceClient<NoteCategoryShare>

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>

NoteCategoryShareClient

Inherited Members

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>.GetAsync(CancellationToken)

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>.PatchAsync(NoteCategoryShare, CancellationToken)

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>.PatchAsync(JsonApiDocument<NoteCategoryShareResource>, CancellationToken)

SingletonResourceClient<NoteCategoryShare, NoteCategoryShareResource, NoteCategoryShareResponse>.DeleteAsync(CancellationToken)

ResourceClient<NoteCategoryShare>.AddQueryParameter(string, string)

ResourceClient<NoteCategoryShare>.ReplaceQueryParameter(string, string)

ResourceClient<NoteCategoryShare>.AddCustomParameter(string, string)

ResourceClient<NoteCategoryShare>.ClearParameters()

ResourceClient<NoteCategoryShare>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteCategoryShare>.Uri

ResourceClient<NoteCategoryShare>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NoteCategoryShareClient(HttpClient, Uri)

Client for interacting with the NoteCategoryShare resource.

public NoteCategoryShareClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePerson()

Include related Person resources in the response.

public NoteCategoryShareClient IncludePerson()

Returns

NoteCategoryShareClient

PatchAsync(NoteCategoryShare, CancellationToken)

Updates an existing NoteCategoryShare resource asynchronously.

public Task<NoteCategoryShareResponse> PatchAsync(NoteCategoryShare resource, CancellationToken cancellationToken = default)

Parameters

resource NoteCategoryShare

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<NoteCategoryShareResource>, CancellationToken)

Updates an existing NoteCategoryShare resource asynchronously.

public Task<NoteCategoryShareResponse> PatchAsync(JsonApiDocument<NoteCategoryShareResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteCategoryShareResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteCategoryShareResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.