file.v2

type: meya.file.component.v2
class: FileV2Component
path: /meya/file/component/v2.py
signature: file

Fields

fieldsignaturerequiredtypedefaultdescription               
specSpecnullOverride the original spec for this element
contextdict{}
Send context data with this component's event
sensitiveboolfalseMark this component's event as sensitive
triggerslist[]Activate these dynamic triggers when the component runs
quick_replieslist[]List of buttons that the user can select for replies
composerComposerElementSpecfocus:
placeholder:
collapse_placeholder:
visibility:
Override the Orb composer for this component
headerHeaderElementSpecbuttons:
title:
progress:
milestones:
extra_buttons:
Override the header for this component
markdownlist
bool
NoneType
nullOverride the bot Markdown mode for this component
filestrThe URL of the file
namestr
iconIconElementSpec
str
NoneType
null
textstrnull

Examples

Basic

triggers:
  - keyword: meya.file.component.v2
steps:
  - file: STRING
    name: STRING

Full

triggers:
  - keyword: meya.file.component.v2
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
    file: STRING
    name: STRING
    icon:
      url: STRING
      color: STRING
      path: STRING
    text: STRING