Tableau Extensions API
    Preparing search index...

    Interface DialogMessageEvent

    An event which is raised when the dialog has a message for the underlying extension (sent using tableau.extensions.ui.sendDialogMessageAsync), or vice versa. Should be listened for directly from the tableau.extensions.ui object. For example, when the dialog sends a message to the extension using tableau.extensions.ui.sendDialogMessageAsync method, the extension should be listening for this event and handling it.

    interface DialogMessageEvent {
        message: string;
        sourceDialogUrl?: string;
        type: TableauEventType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    message sourceDialogUrl? type

    Properties

    message: string

    the message that was sent to/from the dialog.

    sourceDialogUrl?: string

    the url of the dialog that sent the message. If undefined, the message was sent by the host extension itself.

    type: TableauEventType

    The type of event which this class is representing.

    Settings

    Member Visibility

    On This Page

    Properties