Class WorkflowClient

Namespace

Crews.PlanningCenter.Api.People.V2019_01_14

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the Workflow resource.

public class WorkflowClient : SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>

Inheritance

object

ResourceClient<Workflow>

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>

WorkflowClient

Inherited Members

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>.PatchAsync(Workflow, CancellationToken)

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>.PatchAsync(JsonApiDocument<WorkflowResource>, CancellationToken)

SingletonResourceClient<Workflow, WorkflowResource, WorkflowResponse>.DeleteAsync(CancellationToken)

ResourceClient<Workflow>.AddQueryParameter(string, string)

ResourceClient<Workflow>.ReplaceQueryParameter(string, string)

ResourceClient<Workflow>.AddCustomParameter(string, string)

ResourceClient<Workflow>.ClearParameters()

ResourceClient<Workflow>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Workflow>.Uri

ResourceClient<Workflow>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowClient(HttpClient, Uri)

Client for interacting with the Workflow resource.

public WorkflowClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

Cards

Associated Cards.

public PaginatedWorkflowCardClient Cards { get; }

Property Value

PaginatedWorkflowCardClient

Category

Associated Category.

public WorkflowCategoryClient Category { get; }

Property Value

WorkflowCategoryClient

SharedPeople

Associated SharedPeople.

public PaginatedPersonClient SharedPeople { get; }

Property Value

PaginatedPersonClient

Shares

Associated Shares.

public PaginatedWorkflowShareClient Shares { get; }

Property Value

PaginatedWorkflowShareClient

Steps

Associated Steps.

public PaginatedWorkflowStepClient Steps { get; }

Property Value

PaginatedWorkflowStepClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeCategory()

Include related Category resources in the response.

public WorkflowClient IncludeCategory()

Returns

WorkflowClient

IncludeShares()

Include related Shares resources in the response.

public WorkflowClient IncludeShares()

Returns

WorkflowClient

IncludeSteps()

Include related Steps resources in the response.

public WorkflowClient IncludeSteps()

Returns

WorkflowClient

PatchAsync(Workflow, CancellationToken)

Updates an existing Workflow resource asynchronously.

public Task<WorkflowResponse> PatchAsync(Workflow resource, CancellationToken cancellationToken = default)

Parameters

resource Workflow

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<WorkflowResource>, CancellationToken)

Updates an existing Workflow resource asynchronously.

public Task<WorkflowResponse> PatchAsync(JsonApiDocument<WorkflowResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.