Class WorkflowCardActivityClient

Namespace

Crews.PlanningCenter.Api.People.V2022_01_05

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowCardActivity resource.

public class WorkflowCardActivityClient : SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>

Inheritance

object

ResourceClient<WorkflowCardActivity>

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>

WorkflowCardActivityClient

Inherited Members

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>.PatchAsync(WorkflowCardActivity, CancellationToken)

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>.PatchAsync(JsonApiDocument<WorkflowCardActivityResource>, CancellationToken)

SingletonResourceClient<WorkflowCardActivity, WorkflowCardActivityResource, WorkflowCardActivityResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowCardActivity>.AddQueryParameter(string, string)

ResourceClient<WorkflowCardActivity>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowCardActivity>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowCardActivity>.Uri

ResourceClient<WorkflowCardActivity>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowCardActivityClient(HttpClient, Uri)

Client for interacting with the WorkflowCardActivity resource.

public WorkflowCardActivityClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Methods

AddCustomParameter(string, string)

Adds a custom query parameter to the request URI.

public WorkflowCardActivityClient AddCustomParameter(string parameter, string value)

Parameters

parameter string

The name of the query parameter.

value string

The value of the query parameter.

Returns

WorkflowCardActivityClient

The current WorkflowCardActivityClient instance.

ClearParameters()

Removes the entire query string from the request URI.

public WorkflowCardActivityClient ClearParameters()

Returns

WorkflowCardActivityClient

The current WorkflowCardActivityClient instance.

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardActivityResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.