zendesk-messaging-client
    Preparing search index...

    Type Alias ListMessage

    ListMessage List messages are a vertically scrollable set of items that may each contain text, an image, and message actions. Not all messaging channels fully support list messages.

    • Facebook Messenger and WeChat have native support.
    • For LINE and our Android, iOS and Web SDK, Sunshine Conversations converts list messages to carousel.
    • On WhatsApp, Telegram and Twitter, Sunshine Conversations converts list messages to multiple rich messages.
    • On all other platforms, Sunshine Conversations converts list messages to raw text.
    type ListMessage = {
        actions?: ActionSubset[];
        blockChatInput?: boolean;
        items: Item[];
        type: string;
    }
    Index

    Properties

    actions? blockChatInput? items type

    Properties

    actions?: ActionSubset[]

    An array of objects representing the actions associated with the message. The array length is limited by the third party channel.

    blockChatInput?: boolean

    When set to true, the chat input will be disabled on supported client implementations when the message is the most recent one in the history. Can be used for guided flows or to temporarily disable the user's ability to send messages in the conversation.

    items: Item[]

    An array of objects representing the items associated with the message. Only present in carousel and list type messages.

    type: string

    The type of message.

    Settings

    Member Visibility

    On This Page

    Properties