PlaybookStepContext class
Where a step list runs: its caption prefix, its depth, and the chain of playbooks around it.
Constructors
-
PlaybookStepContext({required String playbook, required List<
String> path, int depth = 0, String caption = '', void emit(Map<String, Object?> event)?}) -
Creates a PlaybookStepContext.
const
Properties
- caption → String
-
The caption of the steps around these, e.g.
2/3 · Play log_out ›.final - depth → int
-
How deeply nested the steps are: 0 for a top-level playbook.
final
-
emit
→ void Function(Map<
String, Object?> event)? -
Receives the run's events.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
path
→ List<
String> -
The names of the playbooks from the top of the run down to this one.
final
- playbook → String
-
The name of the playbook the steps belong to.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
nested(
{required int index, required int total, required String title, String? playbook, List< String> ? path}) → PlaybookStepContext -
The context for steps nested in the step at
indexoftotalcalledtitle, belonging toplaybookwithpath. -
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