The handler for topic notifications. A topic providing topic
notifications is subscribed to as normal. The messages received can be
parsed by this handler. To create the handler pass in the topic load
message from the subscription to the topic. Also required is the client,
a notification level and a listener object. The handler can then make
selections of topics to listen for notifications to. When a notification
is received it is passed to the listener object passed in.
public function TopicNotifyTopicHandler(message:TopicMessage, client:DiffusionClient, listener:TopicNotifyListener)
Constructor for a TopicNotifyTopicHandler object. This must have all
the arguments specified
Parameters | message:TopicMessage — The ITL from a subscription to a Topic with
TopicNotifyTopicData
|
|
| client:DiffusionClient — The DiffusionClient used as the connection
|
|
| listener:TopicNotifyListener — A TopicNotifyListener to handle to received
notifications
|
Throws | com.pushtechnology.diffusion.errors:DiffusionProtocolError
— If arguments are not valid
|
public function getAddtionNotificationLevel():NotificationLevel
Returns public function getConnection():DiffusionClient
Returns public function getRemovalNotifications():Boolean
Returns public function getUpdateNotifications():Boolean
Returns public function select(mode:SelectionMode, selection:String):void
Updates the topics notifications that are listened for. The
selections can be added, removed or cleared.
Parameters
| mode:SelectionMode — The operation applied to the set of selections
|
|
| selection:String — The Topic pattern used to match topics to listen
for.
|
Throws | com.pushtechnology.diffusion.errors:DiffusionProtocolError
— If any argument is null
|
public function setNotificationDetails(additions:NotificationLevel, removals:Boolean, updates:Boolean):void
Sets the notification level.
Parameters
| additions:NotificationLevel — The notification level for addition notifications
|
|
| removals:Boolean — The notification level for removal notifications
|
|
| updates:Boolean — The notification level for update notifications
|
Throws | com.pushtechnology.diffusion.errors:DiffusionProtocolError
— If the NotificationLevel is null.
|
public function setNotificationLevel(additions:NotificationLevel):void
Sets the notification level. This sets the level for addition
notifications only. Removed and updated notifications will be
disabled.
Parameters
Throws | com.pushtechnology.diffusion.errors:DiffusionProtocolError
— If the NotificationLevel is null.
|
Mon Feb 6 2017, 01:27 PM Z