ScheduleCommandUnion
PackageFCQRS.Workflows
What the application, or the schedule dispatcher, can ask a schedule to do. Written
`ScheduleCommand.Create` and so on.
Specification
Kind
Union
Members
14
Examples
0
IsCreateSignature
this.IsCreate
IsStartedSignature
this.IsStarted
IsChangeSignature
this.IsChange
IsPauseSignature
this.IsPause
IsResumeSignature
this.IsResume
Summary
| Name | Signature | Synopsis |
|---|---|---|
| IsCreate | this.IsCreate | No description available. |
| IsStarted | this.IsStarted | No description available. |
| IsChange | this.IsChange | No description available. |
| IsPause | this.IsPause | No description available. |
| IsResume | this.IsResume | No description available. |
| IsFire | this.IsFire | No description available. |
| IsDelete | this.IsDelete | No description available. |
| Create | Create ScheduleSpec | Stores a new schedule. |
| Change | Change ScheduleSpec | Replaces the schedule's workflow, input, rule and catch-up policy. |
| Pause | Pause | Stops the schedule from starting runs. |
| Resume | Resume | Lets a paused schedule start runs again, from the first due time after the resume. |
| Delete | Delete | Ends the schedule. |
| Fire | Fire due | Asks to start the run for a due time. |
| Started | Started due | Reports that the run for an accepted due time has been started, or given up because its workflow cannot read the stored input. |
Stores a new schedule.
Parameters
| Name | Type | Description |
|---|---|---|
| Item | ScheduleSpec |
Returns
unit
Replaces the schedule's workflow, input, rule and catch-up policy.
Parameters
| Name | Type | Description |
|---|---|---|
| Item | ScheduleSpec |
Returns
unit
Lets a paused schedule start runs again, from the first due time after the resume.
Returns
unit
Asks to start the run for a due time. The schedule decides whether that due time runs.
Parameters
| Name | Type | Description |
|---|---|---|
| due | DateTime |
Returns
unit