ScheduleClientType
PackageFCQRS.Workflows
The schedules of an actor system, from C#. Get it from `ScheduleHost.Register`.
Specification
Kind
Type
Members
8
Examples
0
ChangeAsyncSignature
this.ChangeAsync
CreateAsyncSignature
this.CreateAsync
CreateAsyncSignature
this.CreateAsync
DeleteAsyncSignature
this.DeleteAsync
PauseAsyncSignature
this.PauseAsync
Summary
| Name | Signature | Synopsis |
|---|---|---|
| ChangeAsync | this.ChangeAsync | Replaces the schedule's workflow, input, rule and catch-up policy. |
| CreateAsync | this.CreateAsync | `CreateAsync` with `CatchUp.Latest`, the default policy: after downtime, the schedule starts one run, for the most recent missed due time. |
| CreateAsync | this.CreateAsync | Creates the schedule `id`, which starts the workflow named `workflow` with `input` at each due time of `rule`, with `catchUp` deciding which missed due times run (the overload without it uses the default, `CatchUp.Latest`). |
| DeleteAsync | this.DeleteAsync | Ends the schedule. |
| PauseAsync | this.PauseAsync | Stops the schedule from starting runs. |
| ResumeAsync | this.ResumeAsync | Lets a paused schedule start runs again, from the first due time after the resume. |
| State | this.State | The schedule as the dispatcher's index knows it, or null when the index has not read it. |
| Handle | this.Handle | The handle the F# functions of `Schedules` take. |
Replaces the schedule's workflow, input, rule and catch-up policy. An `Every` rule counts
from the change. A run decided before the change starts the workflow, with the input, it was
decided with. Throws `ArgumentException` and `InvalidOperationException` as `CreateAsync`
does, and `InvalidOperationException` when the schedule does not exist or was deleted.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| workflow | string | |
| input | 'TInput | |
| rule | ScheduleRule | |
| catchUp | CatchUp |
Returns
Task
`CreateAsync` with `CatchUp.Latest`, the default policy: after downtime, the schedule starts
one run, for the most recent missed due time. Throws as the overload with a policy does.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| workflow | string | |
| input | 'TInput | |
| rule | ScheduleRule |
Returns
Task
Creates the schedule `id`, which starts the workflow named `workflow` with `input` at each
due time of `rule`, with `catchUp` deciding which missed due times run (the overload without
it uses the default, `CatchUp.Latest`). Completes once the schedule is stored. Throws
`ArgumentException` for a rule that `ScheduleRule.validate` rejects, a null rule or policy, or
an ID that is blank, contains '~', or is too long (see `Schedules.MaxIdLength`). Throws
`InvalidOperationException` when the saga starters are not wired, when the workflow is not
registered with the dispatcher or takes another input, and when the schedule refuses: a
schedule with this ID exists with a different content, or was deleted. A repeat with the
same content is accepted and stores nothing; a weekly rule's days are sorted and their
repeats removed before the comparison.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | |
| workflow | string | |
| input | 'TInput | |
| rule | ScheduleRule | |
| catchUp | CatchUp |
Returns
Task
Ends the schedule. A run decided before the delete still starts. The ID cannot be used for
a new schedule. Throws `InvalidOperationException` when the schedule does not exist.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
Task
Stops the schedule from starting runs. A run decided before the pause still starts. Throws
`InvalidOperationException` when the schedule does not exist or was deleted.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
Task
Lets a paused schedule start runs again, from the first due time after the resume. Throws
`InvalidOperationException` when the schedule does not exist, was deleted, or is not paused.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
Task
The schedule as the dispatcher's index knows it, or null when the index has not read it. A
deleted schedule leaves the index once no run decided before the delete waits to start. The
index lags the schedule by one projection pass.
Parameters
| Name | Type | Description |
|---|---|---|
| id | string |
Returns
ScheduleView