Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
caplin.component.comms

CommsChannelListener

The class has been deprecated and may be removed in future releases.
Interface implemented by classes wishing to listen communication channel events such as a component being assigned a communication channel. Classes that are interested in listening to these events can subscribe to them via caplin.component.comms.InterComponentComms#addComponentChannelListener and can then later be removed via caplin.component.comms.InterComponentComms#removeComponentChannelListener. Overriding any of the methods in this listener interface is optional. Doing so will enable you to react to the related event.

Constructor Summary

Attributes Name and Description
caplin.component.comms.CommsChannelListener()

Method Summary

Attributes Name and Description
void onChannelRemoved(caplin.component.Component oComponent, String sChannelId)

Called when the channel associated with the given component is removed.
void onChannelSet(caplin.component.Component oComponent, String sChannelId)

Called when the channel for the given component is set.

Constructor Detail

► caplin.component.comms.CommsChannelListener()

Deprecated
This is deprecated now. You should use the EventHub instead of the open ajax comms.

Method Detail

► void onChannelRemoved(caplin.component.Component oComponent, String sChannelId)

Called when the channel associated with the given component is removed.

Parameters
caplin.component.Component oComponent The component that the channel subscription to be set for.
String sChannelId The Id of the channel

► void onChannelSet(caplin.component.Component oComponent, String sChannelId)

Called when the channel for the given component is set.

Parameters
caplin.component.Component oComponent The component that the channel subscription to be set for.
String sChannelId The Id of the channel