Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

Index

Properties

message

message: string
returns

the message that was sent to/from the dialog.

Optional sourceDialogUrl

sourceDialogUrl: undefined | string
returns

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

type

returns

The type of event which this class is representing.