Element details
type: meya.widget.event.field
class: FieldEvent
path: /meya/widget/event/field/field.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: placeholder: collapse_placeholder: visibility: character_limit: | ComposerEventSpec | |
| quick_replies | ○ | ○ | [] | list | |
| header | ○ | ○ | buttons: title: progress: milestones: extra_buttons: | HeaderEventSpec | |
| markdown | ○ | ○ | [] | list | |
| field_id | ○ | ○ | null | str | |
| submit_button_id | ○ | ○ | null | str | |
| required | ○ | ○ | false | bool | |
| label | ○ | ○ | null | str | |
| disabled | ○ | ○ | false | bool | |
| ok | ○ | ○ | null | bool | |
| error | ○ | ○ | null | str | |
| input_data | ○ | ○ | null | typing.Any | |
Usage reference
Data
{
"type": "meya.widget.event.field",
"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"
],
"field_id": "STRING",
"submit_button_id": "STRING",
"required": false,
"label": "STRING",
"disabled": false,
"ok": false,
"error": "STRING",
"input_data": "ANY"
}
}