flow-click
An HTML content command that starts up a defined Flow as a Background Flow when its host element is clicked. The Background Flow will then, as its name implies, run silently on the background while the user can continue interacting normally with the Screen. If the user leaves the Screen while a Background Flow is still running, it will be automatically stopped.
The expression of flow-click's primary attribute defines the ID of the Flow to run as the Background Flow. The secondary attributes may be used to further detail how the Flow is evaluated.
Secondary attributes
flow-click-segment | ||
|---|---|---|
Required | Value type | EL-evaluated |
No | String | Yes |
Defines the Segment on which the Background Flow starts on. The resolved value is expected to be the ID of a Segment within the Background Flow. If undefined, the Background Flow starts with its first Segment. | ||
flow-click-step | ||
|---|---|---|
Required | Value type | EL-evaluated |
No | String | Yes |
Defines the Step on which the Background Flow's initial Segment starts on. The resolved value is expected to be the ID of a Step within the Segment defined by flow-click-segment, or the Background Flow's first Segment if that secondary attribute is undefined. If undefined, the starting Step is defined by the initial Segment's own settings defining the starting Step. | ||
flow-click-event | ||
|---|---|---|
Required | Value type | EL-evaluated |
No | String | Yes |
Defines the Event value given to the Background Flow evaluation process. This value can affect the starting Steps of the Background Flow's Segments, as according to the standard rules by which Flows operate. Note that if the flow-click-step secondary attribute is defined, the initial Segment will disregard the Event and set that defined Step as its starting Step. All following Segments will react to the Event. If undefined, no Event value is given to the Background Flow. | ||