messages

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Interface which can be used for communications inside applications

Methods

Name Summary
unsubscribe

Unsubscribe listener

send

Send message to the other apps

Methods • Details

unsubscribe(key) → {void}(static)

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Unsubscribe listener

Parameters

Name Type Description
key String

Key returned by subscribe method

Returns

TypeDescription
void

send(message, target, params) → {void}(inner)

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Send message to the other apps

Parameters

Name Type Description
message String

Message name

target String optional

Target name

params Object

Params which will be transferred to the receiver

Returns

TypeDescription
void

Events

message

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Fired when message from some mApp recived Returns {string} handler key

Parameters

Name Type Description
message String

Name of the message

handler messageHandler

Function that is going to be executed when the event is fired

options Object
{
 "ownMessages": boolean
}
optional

Custom settings of subscriber

ownMessages optional

Default value: false.

If true subscriber will be called when message will be triggered inside application. Otherwise only externals events will call subscriber