com.adobe.rtc.util.RootCollectionNode

Package	com.adobe.rtc.util
Class	public class RootCollectionNode
Inheritance	RootCollectionNode CollectionNode flash.events.EventDispatcher

RootCollectionNode is a simple class which allows developers to inspect the state of a room's root. At its root, a room consists of and is organized into a set of CollectionNodes. RootCollectionNode allows the developer to determine this set, using collectionNames, as well as the NODE_CREATE and NODE_DELETE events.

Note that only one RootCollectionNode may be present in an application, and that subscribe() must be called on the RootCollectionNode before use.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		collectionNames : ArrayCollection [read-only] Returns a set of names for all the CollectionNodes in the room.	RootCollectionNode
		connectSession : IConnectSession The IConnectSession with which this component is associated.	CollectionNode
		isEmpty : Boolean Determines whether or not the collection is empty, that is, having no nodes	CollectionNode
		isSynchronized : Boolean Determines whether or not the collection is "up to state" with all previously stored items in its nodes.	CollectionNode
		nodeNames : Array Returns the names of all the nodes within this collection.	CollectionNode
		sharedID : String The `sharedID` is the logical address of this collection within the room and must therefore be unique from all other CollectionNode names.	CollectionNode
		userRoles : Object The complete set of roles for this collection described as {userID:role} pairs.	CollectionNode

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		RootCollectionNode()	RootCollectionNode
		canUserConfigure(p_userID:String, p_nodeName:String = null):Boolean Determines whether a given user is allowed to configue this collection.	CollectionNode
		canUserPublish(p_userID:String, p_nodeName:String):Boolean Determines whether a given user is allowed to publish to a given node in this collection.	CollectionNode
		canUserSubscribe(p_userID:String, p_nodeName:String = null):Boolean Determines whether a given user is allowed to subscribe to this entire collection or a node within it.	CollectionNode
		createNode(p_nodeName:String, p_nodeConfiguration:NodeConfiguration = null):void Creates a new node in this collection; they are either optionally configured when created or accept the default configuration.	CollectionNode
		getExplicitUserRole(p_userID:String, p_nodeName:String = null):int Gets the role of a given user for a node within this collection or the collection itself.	CollectionNode
		getExplicitUserRoles(p_nodeName:String = null):Object Gets the roles explicitly set for a node within this collection.	CollectionNode
		getNodeConfiguration(p_nodeName:String):NodeConfiguration Returns the NodeConfiguration options for a given node in this CollectionNode.	CollectionNode
		getUserRole(p_userID:String, p_nodeName:String = null):int Gets the role of a given user for this collection or a node within it.	CollectionNode
		isNodeDefined(p_nodeName:String):Boolean Whether the given node exists in this CollectionNode.	CollectionNode
		publishItem(p_messageItem:MessageItem, p_overWrite:Boolean = false):void Publishes a MessageItem.	CollectionNode
		removeNode(p_nodeName:String):void Removes the given node from this collection.	CollectionNode
		retractItem(p_nodeName:String, p_itemID:String = null):void Retracts the indicated item.	CollectionNode
		setNodeConfiguration(p_nodeName:String, p_nodeConfiguration:NodeConfiguration):void Configures a node in this collection and replaces the existing NodeConfiguration.	CollectionNode
		setUserRole(p_userID:String, p_role:int, p_nodeName:String = null):void Gives a specific user a specific role level for this entire collection or optionally a specified node within it.	CollectionNode
		subscribe():void Connects the RootCollectionNode to the service; it is required before using the component.	RootCollectionNode
		unsubscribe():void Disconnects this CollectionNode from the server.	CollectionNode

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
configurationChange	Dispatched when a node within the collection has a change in its configuration (typically, its access-model).	CollectionNode
itemReceive	Dispatched when a node within the collection receives an item.	CollectionNode
itemRetract	Dispatched when a node within the collection retracts an item.	CollectionNode
myRoleChange	Dispatched when the current user's role changes for the `collectionNode` as a whole and not nodes within it.	CollectionNode
nodeCreate	Dispatched when a new CollectionNode is added to the room.	RootCollectionNode
nodeCreate	Dispatched when a node is created within the collection.	CollectionNode
nodeDelete	Dispatched when a CollectionNode is removed from the room.	RootCollectionNode
nodeDelete	Dispatched when a node is deleted within the collection.	CollectionNode
reconnect	Dispatched when the collection has been disconnected from the server and is in the process of reconnecting and re-subscribing.	CollectionNode
synchronizationChange	Dispatched when the collection has fully received all nodes and items stored up until the present time thereby becoming synchronized as well as when the collection becomes disconnected from (and thus "out of sync" with) the room's messaging bus.	CollectionNode
userRoleChange	Dispatched when a user's role on the room root changes.	RootCollectionNode
userRoleChange	Dispatched when the collection or a node within the collection, has a change in roles for any user.	CollectionNode

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined by
		NO_EXPLICIT_ROLE : int = -999 [static] When clearing a role at the CollectionNode or the node level, `NO_EXPLICIT_ROLE` is sent to the service to clear that role.	CollectionNode

Property detail

collectionNames

property

collectionNames:ArrayCollection [read-only]

Returns a set of names for all the CollectionNodes in the room.

Implementation
public function get collectionNames():ArrayCollection

Constructor detail

RootCollectionNode

()

constructor

public function RootCollectionNode()

Method detail

()

method

public override function subscribe():void

Connects the RootCollectionNode to the service; it is required before using the component.

Event detail

nodeCreate

event

Event object type: com.adobe.rtc.events.CollectionNodeEvent

Dispatched when a new CollectionNode is added to the room.

nodeDelete

event

Event object type: com.adobe.rtc.events.CollectionNodeEvent

Dispatched when a CollectionNode is removed from the room.

userRoleChange

event

Event object type: com.adobe.rtc.events.CollectionNodeEvent

Dispatched when a user's role on the room root changes.

Current page: http://livedocs.adobe.com/labs/acrobatcom/com/adobe/rtc/util/RootCollectionNode.html

AFCS API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class RootCollectionNode	Properties \| Methods \| Events \| Constants