PlaybookRunner class abstract final

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
nativeTimeout ↔ Duration
How long a screenshot() step waits for Metro before the app captures the screen itself.
getter/setter pair

Static Methods

list() → List<Map<String, Object?>>
Each registered playbook's name, description, speed and step titles.
nativeTaken(String runId, String id, {String? error}) → bool
Tells the run runId that Metro has captured the shot id, or with error, why it couldn't.
start(List<String> names, {PlaybookSpeed? speed, Map<String, dynamic>? data, bool overlay = true, bool loop = false, int countdown = 0, PlaybookScreenshots screenshots = PlaybookScreenshots.off, double pixelRatio = 1.0, ({String? locale, String? theme})? matrix, ScreenshotStore? store, bool frame = false, Color? background, bool native = false, PlaybookClock? clock}) → String
Starts the playbooks names back to back and returns the run's id.
startOnBoot() → void
Starts the playbooks named in PLAYBOOK_ON_BOOT (comma separated) at PLAYBOOK_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.