IWorkflowClient<'TInput, 'TResult>Type
PackageFCQRS.Workflows
Starts and queries the instances of a registered workflow, from C#.
Specification
Kind
Type
Members
7
Examples
0
CancelAsyncSignature
this.CancelAsync
OutcomeAsyncSignature
this.OutcomeAsync
ResultAsyncSignature
this.ResultAsync
SignalAsyncSignature
this.SignalAsync
StartAsyncSignature
this.StartAsync
Summary
| Name | Signature | Synopsis |
|---|---|---|
| CancelAsync | this.CancelAsync | Cancels the instance. |
| OutcomeAsync | this.OutcomeAsync | Waits up to `timeout` for the workflow to end and gives how it ended: finished, faulted, or cancelled. |
| ResultAsync | this.ResultAsync | Waits up to `timeout` for the workflow to end and gives its result. |
| SignalAsync | this.SignalAsync | Stores a signal for the instance. |
| StartAsync | this.StartAsync | Starts the workflow with this ID. |
| StatusAsync | this.StatusAsync | Where the instance is. |
| Name | this.Name | The workflow's name. |
Cancels the instance. Returns once the request is stored.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
Task
Waits up to `timeout` for the workflow to end and gives how it ended: finished, faulted,
or cancelled. Throws `TimeoutException` when the time passes, and
`InvalidOperationException` when no workflow with this ID was started.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| timeout | TimeSpan |
Returns
Task<WorkflowOutcome<'TResult>>
Waits up to `timeout` for the workflow to end and gives its result. Throws
`WorkflowFaultedException`, `WorkflowCancelledException`, or `TimeoutException`.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| timeout | TimeSpan |
Returns
Task<'TResult>
Stores a signal for the instance. Returns once it is stored.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| name | string | |
| payload | 'TSignal |
Returns
Task
Starts the workflow with this ID. True when this call started it; false when a workflow
with this ID already existed, in which case nothing was stored.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| input | 'TInput |
Returns
Task<bool>
Where the instance is.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
Task<WorkflowStatus>