Element details
type: meya.form.event.ask
class: FormAskEvent
path: /meya/form/event/ask.py
signature: -
Fields
field | description
| required | signature | default | type |
|---|---|---|---|---|---|
parent_entry_ref | ○ | ○ | null | EntryRef | |
trace_id | ○ | ○ | "-" | str | |
sensitive | ○ | ○ | false | bool | |
internal | ○ | ○ | false | bool | |
user_id | ◉ | ○ | str | ||
thread_id | ◉ | ○ | str | ||
integration_id | ◉ | ○ | str | ||
context | ○ | ○ | {} | dict | |
composer | ○ | ○ | focus: | ComposerEventSpec | |
quick_replies | ○ | ○ | [] | list | |
header | ○ | ○ | buttons: | HeaderEventSpec | |
markdown | ○ | ○ | [] | list | |
form_id | ◉ | ○ | str | ||
fields | ◉ | ○ | list | ||
text | ○ | ○ | null | str | |
Usage reference
Data
{
"type": "meya.form.event.ask",
"data": {
"parent_entry_ref": {
"ledger": "STRING",
"id": "STRING",
"data": {
"STRING": "STRING"
}
},
"trace_id": "STRING",
"sensitive": false,
"internal": false,
"user_id": "STRING",
"thread_id": "STRING",
"integration_id": "STRING",
"context": {
"STRING": "ANY"
},
"composer": {
"focus": "file|image|text|blur",
"placeholder": "STRING",
"collapse_placeholder": "STRING",
"visibility": "collapse|hide|show",
"character_limit": {
"length": 123,
"error_text": "STRING"
}
},
"quick_replies": [
{
"url": "STRING",
"javascript": "STRING",
"button_id": "STRING",
"context": {
"STRING": "ANY"
},
"default": false,
"disabled": false,
"divider": false,
"icon": {
"url": "STRING",
"color": "STRING"
},
"menu": [
"BUTTONEVENTSPEC"
],
"text": "STRING"
}
],
"header": {
"buttons": [
{
"url": "STRING",
"javascript": "STRING",
"button_id": "STRING",
"context": {
"STRING": "ANY"
},
"default": false,
"disabled": false,
"divider": false,
"icon": {
"url": "STRING",
"color": "STRING"
},
"menu": [
"BUTTONEVENTSPEC"
],
"text": "STRING"
}
],
"title": {
"text": "STRING",
"icon": {
"url": "STRING",
"color": "STRING"
}
},
"progress": {
"value": 123,
"show_percent": false
},
"milestones": [
{
"text": "STRING",
"current": false
}
],
"extra_buttons": [
{
"url": "STRING",
"javascript": "STRING",
"button_id": "STRING",
"context": {
"STRING": "ANY"
},
"default": false,
"disabled": false,
"divider": false,
"icon": {
"url": "STRING",
"color": "STRING"
},
"menu": [
"BUTTONEVENTSPEC"
],
"text": "STRING"
}
]
},
"markdown": [
"format|linkify|breaks|typographer"
],
"form_id": "STRING",
"fields": [
{
"name": "STRING",
"autocomplete": "STRING",
"icon": {
"url": "STRING",
"color": "STRING"
},
"label": "STRING",
"no_results_text": "STRING",
"placeholder": "STRING",
"required": false,
"type": "email|text|select",
"custom": false,
"search": false,
"multi": false,
"options": [
{
"text": "STRING",
"disabled": false
}
],
"default": "ANY"
}
],
"text": "STRING"
}
}