Class WorkflowCardNoteClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowCardNote resource.

public class WorkflowCardNoteClient : SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>

Inheritance

object

ResourceClient<WorkflowCardNote>

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>

WorkflowCardNoteClient

Inherited Members

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>.PatchAsync(WorkflowCardNote, CancellationToken)

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>.PatchAsync(JsonApiDocument<WorkflowCardNoteResource>, CancellationToken)

SingletonResourceClient<WorkflowCardNote, WorkflowCardNoteResource, WorkflowCardNoteResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowCardNote>.AddQueryParameter(string, string)

ResourceClient<WorkflowCardNote>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCardNote>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCardNote>.Uri

ResourceClient<WorkflowCardNote>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowCardNoteClient(HttpClient, Uri)

Client for interacting with the WorkflowCardNote resource.

public WorkflowCardNoteClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowCardNoteClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowCardNoteClient

The current WorkflowCardNoteClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowCardNoteClient ClearParameters()

Returns

WorkflowCardNoteClient

The current WorkflowCardNoteClient instance.

GetAsync(CancellationToken)

Fetches the WorkflowCardNote resource asynchronously.

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardNoteResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.