whatsapp.list_picker

Show a WhatsApp list picker containing a list of buttons for the user to
select.

Element details

type: meya.whatsapp.component.list_picker
class: ListPickerComponent
path: /meya/whatsapp/component/list_picker.py
signature: list_picker

Fields

field

description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

required

signature

default

type

spec

Override the original spec for this element.

null

Spec

context

Send context data with this component's event.

{}

dict

sensitive

Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.

false

bool

triggers

Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.

[]

list

list_picker

The list picker body text

null

str

items

List of buttons that the user can select

list

button

null

str

Usage reference

Basic

triggers:
  - keyword: meya.whatsapp.component.list_picker
steps:
  - list_picker: STRING
    items:
      - value: ANY
        result: ANY

Full

triggers:
  - keyword: meya.whatsapp.component.list_picker
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
    list_picker: STRING
    items:
      - 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:
          - 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
        text: STRING
        description: STRING
    button: STRING