Class ItemNoteClient

Namespace

Crews.PlanningCenter.Api.Services.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the ItemNote resource.

public class ItemNoteClient : SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>

Inheritance

object

ResourceClient<ItemNote>

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>

ItemNoteClient

Inherited Members

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>.PatchAsync(ItemNote, CancellationToken)

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>.PatchAsync(JsonApiDocument<ItemNoteResource>, CancellationToken)

SingletonResourceClient<ItemNote, ItemNoteResource, ItemNoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<ItemNote>.AddQueryParameter(string, string)

ResourceClient<ItemNote>.ReplaceQueryParameter(string, string)

ResourceClient<ItemNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<ItemNote>.Uri

ResourceClient<ItemNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ItemNoteClient(HttpClient, Uri)

Client for interacting with the ItemNote resource.

public ItemNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

ItemNoteCategory

Associated ItemNoteCategory.

public ItemNoteCategoryClient ItemNoteCategory { get; }

Property Value

ItemNoteCategoryClient

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public ItemNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

ItemNoteClient

The current ItemNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public ItemNoteClient ClearParameters()

Returns

ItemNoteClient

The current ItemNoteClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeItemNoteCategory()

Include related ItemNoteCategory resources in the response.

public ItemNoteClient IncludeItemNoteCategory()

Returns

ItemNoteClient

PatchAsync(ItemNote, CancellationToken)

Updates an existing ItemNote resource asynchronously.

public Task<ItemNoteResponse> PatchAsync(ItemNote resource, CancellationToken cancellationToken = default)

Parameters

resource ItemNote

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<ItemNoteResource>, CancellationToken)

Updates an existing ItemNote resource asynchronously.

public Task<ItemNoteResponse> PatchAsync(JsonApiDocument<ItemNoteResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<ItemNoteResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<ItemNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.