| Package | com.adobe.rtc.events |
| Class | public class CollectionNodeEvent |
| Inheritance | CollectionNodeEvent  flash.events.Event |
See also
| Property | Defined by | ||
|---|---|---|---|
| item : MessageItem
For
itemReceive and itemRetract events, item contains the newly received
or retracted MessageItem. | CollectionNodeEvent | ||
| nodeName : String
The node name to which this event pertains.
| CollectionNodeEvent | ||
| userID : String
For
userRoleChange events, the userID contains the ID of the affected user. | CollectionNodeEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
CollectionNodeEvent(p_type:String, p_nodeName:String = "", p_item:MessageItem = null, p_userID:String = "")
| CollectionNodeEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| CONFIGURATION_CHANGE : String = "configurationChange" [static]
The type of event emitted when the CollectionNode receives a change in configuration on one of its nodes.
| CollectionNodeEvent | ||
| ITEM_RECEIVE : String = "itemReceive" [static]
The type of event emitted when the CollectionNode receives an item on one of its nodes.
| CollectionNodeEvent | ||
| ITEM_RETRACT : String = "itemRetract" [static]
The type of event emitted when the CollectionNode retracts an item from one of its nodes.
| CollectionNodeEvent | ||
| MY_ROLE_CHANGE : String = "myRoleChange" [static]
The type of event emitted when the CollectionNode receives a change in
userRole
for the current user on itself only (not on its individual nodes). | CollectionNodeEvent | ||
| NODE_CREATE : String = "nodeCreate" [static]
The type of event emitted when a new node is added to the CollectionNode.
| CollectionNodeEvent | ||
| NODE_DELETE : String = "nodeDelete" [static]
The type of event emitted when a node is deleted from the CollectionNode.
| CollectionNodeEvent | ||
| RECONNECT : String = "reconnect" [static]
The type of event emitted when the CollectionNode is about to reconnect to the server.
| CollectionNodeEvent | ||
| SYNCHRONIZATION_CHANGE : String = "synchronizationChange" [static]
The type of event emitted when the CollectionNode gains or loses synchronization with its source.
| CollectionNodeEvent | ||
| USER_ROLE_CHANGE : String = "userRoleChange" [static]
The type of event emitted when the CollectionNode receives a change in
userRole
(for any user) on itself or one of its nodes. | CollectionNodeEvent | ||
| item | property |
public var item:MessageItem
For itemReceive and itemRetract events, item contains the newly received
or retracted MessageItem.
| nodeName | property |
public var nodeName:String
The node name to which this event pertains. In the case of userRoleChanges for an
entire CollectionNode and myRoleChange, this is null.
| userID | property |
public var userID:String
For userRoleChange events, the userID contains the ID of the affected user.
| CollectionNodeEvent | () | constructor |
public function CollectionNodeEvent(p_type:String, p_nodeName:String = "", p_item:MessageItem = null, p_userID:String = "")Parameters
p_type:String |
|
p_nodeName:String (default = " |
|
p_item:MessageItem (default = null) |
|
p_userID:String (default = " |
| CONFIGURATION_CHANGE | constant |
public static const CONFIGURATION_CHANGE:String = "configurationChange"The type of event emitted when the CollectionNode receives a change in configuration on one of its nodes.
| ITEM_RECEIVE | constant |
public static const ITEM_RECEIVE:String = "itemReceive"The type of event emitted when the CollectionNode receives an item on one of its nodes.
| ITEM_RETRACT | constant |
public static const ITEM_RETRACT:String = "itemRetract"The type of event emitted when the CollectionNode retracts an item from one of its nodes.
| MY_ROLE_CHANGE | constant |
public static const MY_ROLE_CHANGE:String = "myRoleChange"
The type of event emitted when the CollectionNode receives a change in userRole
for the current user on itself only (not on its individual nodes).
This event is the most commonly used of the two role events as it is rare for users to have roles
defined on specific nodes and rare that a user interface cares about the roles of users other
than the current user. For a more general purpose event which handles all cases,
use USER_ROLE_CHANGE.
| NODE_CREATE | constant |
public static const NODE_CREATE:String = "nodeCreate"The type of event emitted when a new node is added to the CollectionNode.
| NODE_DELETE | constant |
public static const NODE_DELETE:String = "nodeDelete"The type of event emitted when a node is deleted from the CollectionNode.
| RECONNECT | constant |
public static const RECONNECT:String = "reconnect"The type of event emitted when the CollectionNode is about to reconnect to the server. This typically happens automatically if the CollectionNode is still subscribed. The typical response to this event is to re-initialize any shared parts of a model from scratch since they are about to be re-received from the server.
| SYNCHRONIZATION_CHANGE | constant |
public static const SYNCHRONIZATION_CHANGE:String = "synchronizationChange"The type of event emitted when the CollectionNode gains or loses synchronization with its source.
| USER_ROLE_CHANGE | constant |
public static const USER_ROLE_CHANGE:String = "userRoleChange"
The type of event emitted when the CollectionNode receives a change in userRole
(for any user) on itself or one of its nodes. In general, this event is only
useful for situations in which users are assigned roles at the individual node level and where
the developer cares about the user roles other than the current user on these nodes.
Use MY_ROLE_CHANGE for its more useful and specific counterpart.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/events/CollectionNodeEvent.html