Class PlanNoteClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_11_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the PlanNote resource.

public class PlanNoteClient : SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>

Inheritance

object

ResourceClient<PlanNote>

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>

PlanNoteClient

Inherited Members

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>.PatchAsync(PlanNote, CancellationToken)

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>.PatchAsync(JsonApiDocument<PlanNoteResource>, CancellationToken)

SingletonResourceClient<PlanNote, PlanNoteResource, PlanNoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<PlanNote>.AddQueryParameter(string, string)

ResourceClient<PlanNote>.ReplaceQueryParameter(string, string)

ResourceClient<PlanNote>.AddCustomParameter(string, string)

ResourceClient<PlanNote>.ClearParameters()

ResourceClient<PlanNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<PlanNote>.Uri

ResourceClient<PlanNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PlanNoteClient(HttpClient, Uri)

Client for interacting with the PlanNote resource.

public PlanNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

PlanNoteCategory

Associated PlanNoteCategory.

public PlanNoteCategoryClient PlanNoteCategory { get; }

Property Value

PlanNoteCategoryClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludePlanNoteCategory()

Include related PlanNoteCategory resources in the response.

public PlanNoteClient IncludePlanNoteCategory()

Returns

PlanNoteClient

PatchAsync(PlanNote, CancellationToken)

Updates an existing PlanNote resource asynchronously.

public Task<PlanNoteResponse> PatchAsync(PlanNote resource, CancellationToken cancellationToken = default)

Parameters

resource PlanNote

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<PlanNoteResource>, CancellationToken)

Updates an existing PlanNote resource asynchronously.

public Task<PlanNoteResponse> PatchAsync(JsonApiDocument<PlanNoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<PlanNoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<PlanNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.