zendesk-messaging-client
    Preparing search index...

    Type Alias CarouselMessageReadable

    Carousel messages are a horizontally scrollable set of items that may each contain text, an image, and message actions. Not all messaging channels fully support carousel messages; currently only Facebook Messenger, LINE, Telegram, Viber, the Web Messenger, the Android SDK and the iOS SDK cover the full functionality. For all other platforms a carousel message is rendered as raw text. The raw text fallback does not include any images or postback message actions.

    type CarouselMessageReadable = {
        blockChatInput?: boolean;
        displaySettings?: { imageAspectRatio?: "horizontal" | "square" };
        items: Item[];
        text?: string;
        type: string;
    }
    Index

    Properties

    blockChatInput? displaySettings? items text? type

    Properties

    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.

    displaySettings?: { imageAspectRatio?: "horizontal" | "square" }

    Settings to adjust the carousel layout.

    Type declaration

    • OptionalimageAspectRatio?: "horizontal" | "square"

      Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels.

    items: Item[]

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

    Optional Readonlytext

    text?: string

    The fallback text message used when carousel messages are not supported by the channel.

    type: string

    The type of message.

    Settings

    Member Visibility

    On This Page

    Properties