Skip to main content

BroadcastMessage

Description​

Sends a synchronous broadcast message to all shellUI modules of all applications running in the current shellUI (main-window).

Syntax​

// shellUI points to instance of IShellUI
await shellUI.BroadcastMessage(msgID, data);

Parameters​

NameOptionalityTypeDescription
msgIDRequiredstringThe broadcast message ID for the listeners.
dataRequiredanyThe broadcast payload data.

Return type​

TypeDescription
Promise < void >Method does not return a value

Exceptions​

ArgumentError - When msgID or data is null or undefined.