ScheduleEventUnion
PackageFCQRS.Workflows
What a schedule replies, and stores. Written `ScheduleEvent.Created` and so on. Every case
except `Refused` is stored in the schedule's journal, so the cases and their fields are a
persistent contract.
Specification
Kind
Union
Members
16
Examples
0
IsPausedSignature
this.IsPaused
IsFiredSignature
this.IsFired
IsFiringSignature
this.IsFiring
IsDeletedSignature
this.IsDeleted
IsRefusedSignature
this.IsRefused
Summary
| Name | Signature | Synopsis |
|---|---|---|
| IsPaused | this.IsPaused | No description available. |
| IsFired | this.IsFired | No description available. |
| IsFiring | this.IsFiring | No description available. |
| IsDeleted | this.IsDeleted | No description available. |
| IsRefused | this.IsRefused | No description available. |
| IsCreated | this.IsCreated | No description available. |
| IsResumed | this.IsResumed | No description available. |
| IsChanged | this.IsChanged | No description available. |
| Created | Created(spec, at) | The schedule was created at `at`, which an `Every` rule counts from. |
| Changed | Changed(spec, at) | The schedule's spec was replaced at `at`, which an `Every` rule counts from. |
| Paused | Paused at | The schedule stopped starting runs. |
| Resumed | Resumed at | The schedule starts runs again. |
| Deleted | Deleted at | The schedule ended. |
| Firing | Firing(due, workflow, input) | A run for `due` was decided, with the workflow it starts and the input it gets. |
| Fired | Fired due | The run for `due` has been started, or given up because its workflow cannot read the stored input. |
| Refused | Refused reason | A command was refused. |
The schedule was created at `at`, which an `Every` rule counts from.
Parameters
| Name | Type | Description |
|---|---|---|
| spec | ScheduleSpec | |
| at | DateTime |
Returns
unit
The schedule's spec was replaced at `at`, which an `Every` rule counts from. No due time at
or before `at` runs.
Parameters
| Name | Type | Description |
|---|---|---|
| spec | ScheduleSpec | |
| at | DateTime |
Returns
unit
The schedule stopped starting runs.
Parameters
| Name | Type | Description |
|---|---|---|
| at | DateTime |
Returns
unit
The schedule starts runs again. No due time at or before `at` runs.
Parameters
| Name | Type | Description |
|---|---|---|
| at | DateTime |
Returns
unit
A run for `due` was decided, with the workflow it starts and the input it gets. A later
change does not alter either.
Parameters
| Name | Type | Description |
|---|---|---|
| due | DateTime | |
| workflow | string | |
| input | Payload |
Returns
unit
The run for `due` has been started, or given up because its workflow cannot read the
stored input.
Parameters
| Name | Type | Description |
|---|---|---|
| due | DateTime |
Returns
unit