Table of Contents

Class WorkflowCardClient

Namespace
Crews.PlanningCenter.Api.People.V2019_01_14
Assembly
Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowCard resource.

public class WorkflowCardClient : SingletonResourceClient<WorkflowCard, WorkflowCardResource, WorkflowCardResponse>
Inheritance
WorkflowCardClient
Inherited Members

Constructors

WorkflowCardClient(HttpClient, Uri)

Client for interacting with the WorkflowCard resource.

public WorkflowCardClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient
uri Uri

Properties

Activities

Associated Activities.

public PaginatedWorkflowCardActivityClient Activities { get; }

Property Value

PaginatedWorkflowCardActivityClient

Assignee

Associated Assignee.

public PersonClient Assignee { get; }

Property Value

PersonClient

CurrentStep

Associated CurrentStep.

public WorkflowStepClient CurrentStep { get; }

Property Value

WorkflowStepClient

Notes

Associated Notes.

public PaginatedWorkflowCardNoteClient Notes { get; }

Property Value

PaginatedWorkflowCardNoteClient

Person

Associated Person.

public PersonClient Person { get; }

Property Value

PersonClient

Workflow

Associated Workflow.

public WorkflowClient Workflow { get; }

Property Value

WorkflowClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

GoBackAsync(CancellationToken)

Move a Workflow Card back to the previous step.

public Task GoBackAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

IncludeAssignee()

Include related Assignee resources in the response.

public WorkflowCardClient IncludeAssignee()

Returns

WorkflowCardClient

IncludeCurrentStep()

Include related CurrentStep resources in the response.

public WorkflowCardClient IncludeCurrentStep()

Returns

WorkflowCardClient

IncludePerson()

Include related Person resources in the response.

public WorkflowCardClient IncludePerson()

Returns

WorkflowCardClient

IncludeWorkflow()

Include related Workflow resources in the response.

public WorkflowCardClient IncludeWorkflow()

Returns

WorkflowCardClient

PatchAsync(WorkflowCard, CancellationToken)

Updates an existing WorkflowCard resource asynchronously.

public Task<WorkflowCardResponse> PatchAsync(WorkflowCard resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowCard

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<WorkflowCardResource>, CancellationToken)

Updates an existing WorkflowCard resource asynchronously.

public Task<WorkflowCardResponse> PatchAsync(JsonApiDocument<WorkflowCardResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowCardResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowCardResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PromoteAsync(CancellationToken)

Move a Workflow Card to the next step.

public Task PromoteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

RemoveAsync(CancellationToken)

Removes a card

public Task RemoveAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

RestoreAsync(CancellationToken)

Restore a card

public Task RestoreAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

SendEmailAsync(CancellationToken)

Sends an email to the subject of the card
Pass in a subject and note.

public Task SendEmailAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

SkipStepAsync(CancellationToken)

Move a Workflow Card to the next step without completing the current step.

public Task SkipStepAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

SnoozeAsync(CancellationToken)

Snoozes a card for a specific duration
Pass in a duration in days.

public Task SnoozeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

UnsnoozeAsync(CancellationToken)

Unsnoozes a card

public Task UnsnoozeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task
Edit this page