email.address.ask.form

type: meya.email.component.address.ask.form
class: EmailAddressAskFormComponent
path: /meya/email/component/address/ask/form.py
signature: ask_form, expect

Fields

field

signature

required

type

default

description               

spec

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: blur
placeholder:
collapse_placeholder:
visibility:

header

HeaderElementSpec

buttons:
title:
progress:
milestones:
extra_buttons:

Override the header for this component

markdown

list
bool
NoneType

null

Override the bot Markdown mode for this component

ask_form

str

null

expect

Expect

null

field_name

str

"email"

autocomplete

str

"email"

label

str

"Email"

placeholder

str

"Your email address"

icon

IconElementSpec
str
NoneType

null

retries

Real

"inf"

error_message

str

"Invalid email"

Examples

Basic

triggers:
  - keyword: meya.email.component.address.ask.form
steps:
  - ask_form: STRING
    expect: email_address

Full

triggers:
  - keyword: meya.email.component.address.ask.form
steps:
  - spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    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
        default: false
        disabled: false
        divider: false
        icon:
          url: STRING
          color: STRING
          path: STRING
        action: COMPONENT
        value: ANY
        result: ANY
        data:
          STRING: ANY
        magic: false
        type: text|url|static|menu|divider|action|flow_next|component_next
        menu:
          - BUTTONELEMENTSPEC
        text: STRING
    composer:
      focus: file|image|text|blur
      placeholder: STRING
      collapse_placeholder: STRING
      visibility: collapse|hide|show
    header:
      buttons:
        - url: STRING
          javascript: STRING
          button_id: STRING
          context:
            STRING: ANY
          default: false
          disabled: false
          divider: false
          icon:
            url: STRING
            color: STRING
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          type: text|url|static|menu|divider|action|flow_next|component_next
          menu:
            - BUTTONELEMENTSPEC
          text: STRING
      title:
        text: STRING
        icon:
          url: STRING
          color: STRING
          path: 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
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          type: text|url|static|menu|divider|action|flow_next|component_next
          menu:
            - BUTTONELEMENTSPEC
          text: STRING
    markdown:
      - format|linkify|breaks|typographer
    ask_form: STRING
    expect: email_address
    field_name: STRING
    autocomplete: STRING
    label: STRING
    placeholder: STRING
    icon:
      url: STRING
      color: STRING
      path: STRING
    retries: 123
    error_message: STRING