text.input

type: meya.text.event.input
class: TextInputEvent
path: /meya/text/event/input.py
signature: -

Fields

field

signature

required

type

default

description               

parent_entry_ref

EntryRef

null

trace_id

str

"-"

sensitive

bool

false

user_id

str

thread_id

str

integration_id

str

context

dict

{}

composer

ComposerEventSpec

focus:
placeholder:
collapse_placeholder:
visibility:

quick_replies

list

[]

header

HeaderEventSpec

buttons:
title:
progress:
milestones:
extra_buttons:

markdown

list

[]

field_id

str

null

submit_button_id

str

null

required

bool

false

label

str

null

disabled

bool

false

ok

bool

null

error

str

null

input_data

typing.Any

null

icon

IconEventSpec

null

placeholder

str

null

default

str

null

type

TextInputType

Examples

Data

{
    "type": "meya.text.event.input", 
    "data": {
        "parent_entry_ref": {
            "ledger": "STRING", 
            "id": "STRING", 
            "data": {
                "STRING": "STRING"
            }
        }, 
        "trace_id": "STRING", 
        "sensitive": 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"
        }, 
        "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", 
        "icon": {
            "url": "STRING", 
            "color": "STRING"
        }, 
        "placeholder": "STRING", 
        "default": "STRING", 
        "type": "text|email"
    }
}