Element details
type: meya.widget.trigger.field.button_trigger
class: FieldButtonTrigger
path: /meya/widget/trigger/field/button_trigger.py
signature: button_id
Fields
| field | description | required | signature | default | type |
|---|---|---|---|---|---|
| spec | Override the original spec for this element. | ○ | ○ | null | Spec |
| bot | Bot used to evaluate this trigger. | ○ | ○ | null | BotRef |
| action | Action executed if this trigger matches. Check the trigger action guide for more info. | ◉ | ○ | TriggerActionEntry ActionComponentSpec | |
| when | Optionally set the criteria when this trigger should evaluate. The default is true and will always evaluate. | ○ | ○ | true | typing.Any |
| confidence | Override the default confidence with a custom value for trigger matches. | ○ | ○ | null | Real |
| button_id | The static button ID to match against. Use this button ID in the button_id field in the relevant quick replies and buttons. | ◉ | ◉ | str | |
| text | DEPRECATED | ○ | ○ | null | str |
Usage reference
Basic
triggers:
- button_id: STRING
steps:
- say: STRING
Full
type: meya.widget.trigger.field.button_trigger
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
bot: element.name
action: COMPONENT
when: ANY
confidence: 123
button_id: STRING
text: STRING