type: meya.text.component.ask
class: AskComponent
path: /meya/text/component/ask/ask.py
signature: ask

Get basic text input from the user.

Fields

field	signature	required	type	default	description
spec	○	○	ForwardRef('Spec')	null	Override the original spec for this element
context	○	○	dict	{}	Send context data with this component's event
sensitive	○	○	bool	false	Mark this component's event as sensitive
triggers	○	○	list	[]	Activate these dynamic triggers when the component runs
quick_replies	○	○	list	[]	List of buttons that the user can select for replies
composer	○	○	ComposerElementSpec	focus: text placeholder: visibility: show
markdown	○	○	list bool NoneType	null	Override the bot Markdown mode for this component
ask	◉	○	str		Question to send to the user
retries	○	○	Real	"inf"
error_message	○	○	str	"Invalid input, please try again."

Examples

Basic

triggers:
  - keyword: meya.text.component.ask
steps:
  - ask: STRING

Full

triggers:
  - keyword: meya.text.component.ask
steps:
  - spec: '?'
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    quick_replies:
      - url: STRING
        javascript: STRING
        button_id: STRING
        context:
          STRING: ANY
        icon:
          url: STRING
          color: STRING
          path: STRING
        action: COMPONENT
        result: ANY
        data:
          STRING: ANY
        magic: false
        type: text|url|static|action|flow_next|component_next
        text: STRING
    composer:
      focus: file|image|text|blur
      placeholder: STRING
      visibility: collapse|hide|show
    markdown:
      - format|linkify|breaks|typographer
    ask: STRING
    retries: 123
    error_message: STRING