| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IMessageBus |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
IMessageBus interface provides methods for handling inter-tile communication.
Related API Elements
| Method | Defined By | ||
|---|---|---|---|
Adds a listener for a namespace and name combination. | IMessageBus | ||
Removes a listener for a namespace and name combination. | IMessageBus | ||
Sends a message to all the tiles in a LiveCycle Mosaic application. | IMessageBus | ||
addMessageListener | () | method |
public function addMessageListener(namespace:String, name:String, handler:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Adds a listener for a namespace and name combination.
After calling this method, the listener is called anytime a message that matches the namespace and name is sent by any other tile in the application.
Parameters
namespace:String — The namespace of the message.
| |
name:String — The name of the message to listen for.
| |
handler:Function — A function that triggers once for each sendMessage that is called that matches the namespace and name. The function takes one parameter of type Message.
|
Related API Elements
removeMessageListener | () | method |
public function removeMessageListener(namespace:String, name:String, handler:Function):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Removes a listener for a namespace and name combination.
After calling this method, the listener is no longer called anytime a message that matches the namespace and name is sent by any other tile in the application.
Parameters
namespace:String — The namespace of the message.
| |
name:String — The name of the message to no longer listen for.
| |
handler:Function — The function to no longer be called.
|
Related API Elements
sendMessage | () | method |
public function sendMessage(message:Message):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Sends a message to all the tiles in a LiveCycle Mosaic application.
This is used to convey transitory information across all the tiles in the application. The messages are not kept or queued for later processing, they are only visible to tiles that are in the application at the time the message is sent.
Parameters
message:Message — The message to send.
|
Wed Nov 21 2018, 06:34 AM -08:00