zendesk-messaging-client
    Preparing search index...

    Type Alias FormMessageReadable

    A form type message without text or actions. Only supported in the Web SDK.

    type FormMessageReadable = {
        blockChatInput?: boolean;
        fields: FormMessageField[];
        submitted?: boolean;
        type: string;
    }
    Index

    Properties

    blockChatInput? fields submitted? 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..

    fields: FormMessageField[]

    An array of objects representing fields associated with the message. Only present in form and formResponse messages.

    submitted?: boolean

    Flag which states whether the form is submitted.

    type: string

    The type of message.

    Settings

    Member Visibility

    On This Page

    Properties