Runs registered playbooks by name, for Metro and PLAYBOOK_ON_BOOT.
A run returns its id straight away and reports each step as a
nylo.playbook event, so Metro can stream a playbook that takes longer
than a command is allowed to.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- activeRunId → String?
-
The id of the run in progress, or null.
no setter
-
done
→ Future<
void> -
Completes when the run in progress ends, or straight away.
no setter
Static Methods
-
list(
) → List< Map< String, Object?> > - Each registered playbook's name, description, speed and step titles.
-
start(
List< String> names, {PlaybookSpeed? speed, Map<String, dynamic> ? data, bool overlay = true, bool loop = false, PlaybookClock? clock}) → String -
Starts the playbooks
namesback to back and returns the run's id. -
startOnBoot(
) → void -
Starts the playbooks named in
PLAYBOOK_ON_BOOT(comma separated) atPLAYBOOK_SPEED, once the app's first frame is on screen. -
stop(
[String? runId]) → bool -
Stops the run
runId, or whichever is running when it's null.