Class WorkflowStepClient

Namespace

Crews.PlanningCenter.Api.People.V2024_09_12

Assembly

Crews.PlanningCenter.Api.dll

Client for interacting with the WorkflowStep resource.

public class WorkflowStepClient : SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>

Inheritance

object

ResourceClient<WorkflowStep>

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>

WorkflowStepClient

Inherited Members

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>.GetAsync(CancellationToken)

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>.PatchAsync(WorkflowStep, CancellationToken)

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>.PatchAsync(JsonApiDocument<WorkflowStepResource>, CancellationToken)

SingletonResourceClient<WorkflowStep, WorkflowStepResource, WorkflowStepResponse>.DeleteAsync(CancellationToken)

ResourceClient<WorkflowStep>.AddQueryParameter(string, string)

ResourceClient<WorkflowStep>.ReplaceQueryParameter(string, string)

ResourceClient<WorkflowStep>.AddCustomParameter(string, string)

ResourceClient<WorkflowStep>.ClearParameters()

ResourceClient<WorkflowStep>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<WorkflowStep>.Uri

ResourceClient<WorkflowStep>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

WorkflowStepClient(HttpClient, Uri)

Client for interacting with the WorkflowStep resource.

public WorkflowStepClient(HttpClient httpClient, Uri uri)

Parameters

httpClient HttpClient

uri Uri

Properties

AssigneeSummaries

Associated AssigneeSummaries.

public PaginatedWorkflowStepAssigneeSummaryClient AssigneeSummaries { get; }

Property Value

PaginatedWorkflowStepAssigneeSummaryClient

DefaultAssignee

Associated DefaultAssignee.

public PersonClient DefaultAssignee { get; }

Property Value

PersonClient

Methods

DeleteAsync(CancellationToken)

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

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

Parameters

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

IncludeDefaultAssignee()

Include related DefaultAssignee resources in the response.

public WorkflowStepClient IncludeDefaultAssignee()

Returns

WorkflowStepClient

PatchAsync(WorkflowStep, CancellationToken)

Updates an existing WorkflowStep resource asynchronously.

public Task<WorkflowStepResponse> PatchAsync(WorkflowStep resource, CancellationToken cancellationToken = default)

Parameters

resource WorkflowStep

The resource data to be sent in the patch request.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.

PatchAsync(JsonApiDocument<WorkflowStepResource>, CancellationToken)

Updates an existing WorkflowStep resource asynchronously.

public Task<WorkflowStepResponse> PatchAsync(JsonApiDocument<WorkflowStepResource> document, CancellationToken cancellationToken = default)

Parameters

document JsonApiDocument<WorkflowStepResource>

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

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<WorkflowStepResponse>

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

Exceptions

JsonApiException

Thrown when the HTTP response indicates a failure status code.