Conversational Actions were deprecated on June 13, 2023. For more information, see Conversational Actions sunset .

ConditionalEvent

AI-generated Key Takeaways

Conditional events trigger based on a true condition.
The condition field is a required string that acts as a filter, supporting session/user storage references, boolean operators, comparisons, and list/string operators.
The optional transitionToScene field specifies a destination scene to jump to when the condition is true.
The optional handler field is an EventHandler object triggered when the condition is true, typically used for generating prompts before a scene transition.

YAML representation

Registers events that trigger as the result of a true condition.

YAML representation
condition : string transitionToScene : string handler : object ( `EventHandler` )

Fields

Fields
`condition`	`string` Required. Filter condition for this event to trigger. If condition is evaluated to true then the associated `handler` will be triggered. The following variable references are supported: `$session` - To reference data in session storage. `$user` - To reference data in user storage. The following boolean operators are supported (with examples): `&&` - `session.params.counter > 0 && session.params.counter < 100` `\|\|` - `session.params.foo == "John" \|\| session.params.counter == "Adam"` `!` - `!(session.params.counter == 5)` The following comparisons are supported: `==` , `!=` , `<` , `>` , `<=` , `>=` The following list and string operators are supported (with examples): `in` - "Watermelon" in `session.params.fruitList` `size` - `size(session.params.fruitList) > 2` `substring` - `session.params.fullName.contains("John")`
`transitionToScene`	`string` Optional. Destination scene which the conversation should jump to when the associated condition is evaluated to true. The state of the current scene is destroyed on the transition.
`handler`	`object ( EventHandler )` Optional. Event handler which is triggered when the associated condition is evaluated to `true` . Should execute before transitioning to the destination scene. Useful to generate Prompts in response to events.

condition

string

Required. Filter condition for this event to trigger. If condition is evaluated to true then the associated handler will be triggered. The following variable references are supported: $session - To reference data in session storage. $user - To reference data in user storage. The following boolean operators are supported (with examples): && - session.params.counter > 0 && session.params.counter < 100 || - session.params.foo == "John" || session.params.counter == "Adam" ! - !(session.params.counter == 5) The following comparisons are supported: == , != , < , > , <= , >= The following list and string operators are supported (with examples): in - "Watermelon" in session.params.fruitList size - size(session.params.fruitList) > 2 substring - session.params.fullName.contains("John")

transitionToScene

string

Optional. Destination scene which the conversation should jump to when the associated condition is evaluated to true. The state of the current scene is destroyed on the transition.

handler

object ( EventHandler )

Optional. Event handler which is triggered when the associated condition is evaluated to true . Should execute before transitioning to the destination scene. Useful to generate Prompts in response to events.

ConditionalEvent Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

ConditionalEvent