Action API object

Hierarchy

Implements

Constructors

Properties

Constructors

  • Builds an action component for an Interactive message Required if interactive type is "list"

    Parameters

    • button: string

      Button content. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 characters.

    • Rest ...sections: AtLeastOne<ListSection>

      Sections of the list

    Returns ActionList

    Throws

    If button is an empty string

    Throws

    If button is over 20 characters

    Throws

    If more than 10 sections are provided

    Throws

    If more than 1 section is provided and at least one doesn't have a title

Properties

button: string

The button text

sections: ListSection[]

The sections of the action

Generated using TypeDoc