nsIFrameMessageManager

Provides methods for managing message listeners on local frames. This provides a way for local frames to receive messages from remote frames.
1.0
28
Introduced
Gecko 2.0
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Method overview

void addMessageListener(in AString aMessage, in nsIFrameMessageListener aListener);
void removeMessageListener(in AString aMessage, in nsIFrameMessageListener aListener);
void sendAsyncMessage(in AString aMessage, in AString json);

Methods

addMessageListener()

Adds a message listener to the local frame. This listener will receive messages sent from the remote frame.

void addMessageListener(
  in AString aMessage,
  in nsIFrameMessageListener aListener
);
Parameters
aMessage
The name of the message for which to add a listener.
aListener
An object implementing nsIFrameMessageListener whose receiveMessage method will be called when the message is received.

removeMessageListener()

Removes a message listener previously added by calling addMessageListener().

void removeMessageListener(
  in AString aMessage,
  in nsIFrameMessageListener aListener
);
Parameters
aMessage
The name of the message for which to remove a listener.
aListener
An object implementing nsIFrameMessageListener to stop receiving messages.

sendAsyncMessage()

Asynchronously sends a message to the listeners.

void sendAsyncMessage(
  in AString aMessage,
  in AString json
); 
Parameters
aMessage
The name of the message to send to the listeners.
json Optional
A JSON object containing data to be delivered to the listeners.

See also


Document Tags and Contributors

Contributors to this page: Sheppy, nikhilm, Laurentj
Last updated by: Sheppy,