Packagecom.pushtechnology.diffusion
Classpublic final class TopicNotifyTopicHandler
InheritanceTopicNotifyTopicHandler Inheritance Object

Since : 4.6

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 Methods
 MethodDefined By
  
Constructor for a TopicNotifyTopicHandler object.
TopicNotifyTopicHandler
  
TopicNotifyTopicHandler
  
TopicNotifyTopicHandler
  
TopicNotifyTopicHandler
  
TopicNotifyTopicHandler
  
select(mode:SelectionMode, selection:String):void
Updates the topics notifications that are listened for.
TopicNotifyTopicHandler
  
setNotificationDetails(additions:NotificationLevel, removals:Boolean, updates:Boolean):void
Sets the notification level.
TopicNotifyTopicHandler
  
Sets the notification level.
TopicNotifyTopicHandler
Constructor Detail
TopicNotifyTopicHandler()Constructor
public function TopicNotifyTopicHandler(message:TopicMessage, client:DiffusionClient, listener:TopicNotifyListener)

Since : 4.6

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
Method Detail
getAddtionNotificationLevel()method
public function getAddtionNotificationLevel():NotificationLevel

Returns
NotificationLevel
getConnection()method 
public function getConnection():DiffusionClient

Returns
DiffusionClient
getRemovalNotifications()method 
public function getRemovalNotifications():Boolean

Returns
Boolean
getUpdateNotifications()method 
public function getUpdateNotifications():Boolean

Returns
Boolean
select()method 
public function select(mode:SelectionMode, selection:String):void

Since : 4.6

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
setNotificationDetails()method 
public function setNotificationDetails(additions:NotificationLevel, removals:Boolean, updates:Boolean):void

Since : 4.6

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.
setNotificationLevel()method 
public function setNotificationLevel(additions:NotificationLevel):void

Since : 4.6

Sets the notification level. This sets the level for addition notifications only. Removed and updated notifications will be disabled.

Parameters

additions:NotificationLevel — The notification level for addition notifications


Throws
com.pushtechnology.diffusion.errors:DiffusionProtocolError — If the NotificationLevel is null.