Class NoteTemplateClient

Namespace

Crews.PlanningCenter.Api.Publishing.V2018_08_01

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the NoteTemplate resource.

public class NoteTemplateClient : SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>

Inheritance

object

ResourceClient<NoteTemplate>

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>

NoteTemplateClient

Inherited Members

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>.GetAsync(CancellationToken)

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>.PatchAsync(NoteTemplate, CancellationToken)

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>.PatchAsync(JsonApiDocument<NoteTemplateResource>, CancellationToken)

SingletonResourceClient<NoteTemplate, NoteTemplateResource, NoteTemplateResponse>.DeleteAsync(CancellationToken)

ResourceClient<NoteTemplate>.AddQueryParameter(string, string)

ResourceClient<NoteTemplate>.ReplaceQueryParameter(string, string)

ResourceClient<NoteTemplate>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<NoteTemplate>.Uri

ResourceClient<NoteTemplate>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

NoteTemplateClient(HttpClient, Uri)

Client for interacting with the NoteTemplate resource.

public NoteTemplateClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public NoteTemplateClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

NoteTemplateClient

The current NoteTemplateClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public NoteTemplateClient ClearParameters()

Returns

NoteTemplateClient

The current NoteTemplateClient instance.

GetAsync(CancellationToken)

Fetches the NoteTemplate resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(NoteTemplate, CancellationToken)

Updates an existing NoteTemplate resource asynchronously.

public Task<NoteTemplateResponse> PatchAsync(NoteTemplate resource, CancellationToken cancellationToken = default)

Parameters

resource NoteTemplate

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<NoteTemplateResource>, CancellationToken)

Updates an existing NoteTemplate resource asynchronously.

public Task<NoteTemplateResponse> PatchAsync(JsonApiDocument<NoteTemplateResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<NoteTemplateResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<NoteTemplateResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.