Class NoteClient

Namespace

Crews.PlanningCenter.Api.People.V2023_02_15

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Note resource.

public class NoteClient : SingletonResourceClient<Note, NoteResource, NoteResponse>

Inheritance

object

ResourceClient<Note>

SingletonResourceClient<Note, NoteResource, NoteResponse>

NoteClient

Inherited Members

SingletonResourceClient<Note, NoteResource, NoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PatchAsync(Note, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.PatchAsync(JsonApiDocument<NoteResource>, CancellationToken)

SingletonResourceClient<Note, NoteResource, NoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<Note>.AddQueryParameter(string, string)

ResourceClient<Note>.ReplaceQueryParameter(string, string)

ResourceClient<Note>.AddCustomParameter(string, string)

ResourceClient<Note>.ClearParameters()

ResourceClient<Note>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Note>.Uri

ResourceClient<Note>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NoteClient(HttpClient, Uri)

Client for interacting with the Note resource.

public NoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Category

Associated Category.

public NoteCategoryClient Category { get; }

Property Value

NoteCategoryClient

CreatedBy

Associated CreatedBy.

public PersonClient CreatedBy { get; }

Property Value

PersonClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCategory()

Include related Category resources in the response.

public NoteClient IncludeCategory()

Returns

NoteClient

IncludeCreatedBy()

Include related CreatedBy resources in the response.

public NoteClient IncludeCreatedBy()

Returns

NoteClient

IncludePerson()

Include related Person resources in the response.

public NoteClient IncludePerson()

Returns

NoteClient

PatchAsync(Note, CancellationToken)

Updates an existing Note resource asynchronously.

public Task<NoteResponse> PatchAsync(Note resource, CancellationToken cancellationToken = default)

Parameters

resource Note

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<NoteResource>, CancellationToken)

Updates an existing Note resource asynchronously.

public Task<NoteResponse> PatchAsync(JsonApiDocument<NoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.