The IConnectSession with which this component is associated. Note that this may only be set once before subscribe is called; re-sessioning of components is not supported. Defaults to the first IConnectSession created in the application.

Determines whether or not the collection is empty, that is, having no nodes

Determines whether or not the collection is "up to state" with all previously stored items in its nodes. Once a CollectionNode has successfully connected to the service and retrieved all its nodes and messageItems, it is considered synchronized. If the connection is lost, it becomes unsynchronized until it fully reconnects and re-retrieves its state.

Returns the names of all the nodes within this collection.

This property can be used as the source for data binding.

The sharedID is the logical address of this collection within the room and must therefore be unique from all other CollectionNode names.

The complete set of roles for this collection described as {userID:role} pairs.

Determines whether a given user is allowed to configue this collection.

Determines whether a given user is allowed to publish to a given node in this collection.

Determines whether a given user is allowed to subscribe to this entire collection or a node within it.

Creates a new node in this collection; they are either optionally configured when created or accept the default configuration. Note that only users with and owner role may create or configure nodes on a CollectionNode.

Fetches the set of items specified by itemIDs from a given node. This will result in one ITEM_RECEIVE event per item retrieved, for the current user. Attempts to fetch items which don't exist fails silently.

Gets the role of a given user for a node within this collection or the collection itself. This only returns the explicit roles set on the particular node and doesn't look up the cascading roles from the root as getUserRole() does.

Gets the roles explicitly set for a node within this collection. This only returns the explicit roles set on the particular node and doesn't look up the cascading roles from the root as getUserRole() does.

Returns the NodeConfiguration options for a given node in this CollectionNode.

Gets the role of a given user for this collection or a node within it. Note that this function discovers the implicit or cascading role of the user at this location; that is, if no explicit role is specified for a node, the user's role on the parent collection's is queried. If the user's role isn't explicitly defined on the collection, the root role is queried.

Whether the given node exists in this CollectionNode.

Publishes a MessageItem. The MessageItem itself will have a nodeName declared.

p_overWrite provides users with control over whether edits take precedence over delete actions. It is essentially a lock that assures an item can only be published if it exists. The general rule of thumb is that if you want to add a new item, use the p_overWrite default flag of false. If you're editing an item that may be retracted, then set the flag according to your preference.

For example, consider a whiteboard, where each shape is represented by one or more items. For a dynamic system like a whiteboard, shapes can be modified and retracted. p_overwrite makes sure that if you modify a shape but a message race causes that item to be deleted before the edit is committed, the delete takes precedence over the edit. Since the edit is meaningless on a non-existent item, that action is not accepted; otherwise, the edit would cause the shape to exist again. Parameters

Removes the given node from this collection. Only users with an owner role may change a node's configuration.

Retracts the indicated item. This removes the item from storage on the server and sends an itemRetract event to all users.

Configures a node in this collection and replaces the existing NodeConfiguration. Only users with an owner role may change a node's configuration.

Gives a specific user a specific role level for this entire collection or optionally a specified node within it. Roles cascade down from the root level of the room to the CollectionNode level and then to the node level. The following override rules apply:

• Setting a role on a collection node overrides the role at the root for that collection node.
• Setting a role on a node overrides both the role at the root and the collection node for that node.

subscribe() causes the CollectionNode to subscribe to the logical destination provided by collectionName. If there is no such destination on the service and the current user has an owner role, a new CollectionNode is created and stored on the service with the given collectionName. When subscription is successful or a new CollectionNode is created, the collection:

• Discovers all the accessible nodes for this collection along with their configurations and roles.
• Subscribes to all nodes allowed within the collection.
• Retrievs all stored items for all nodes within it and broadcasts ITEM_RECEIVE events for each.
• Fires a COLLECTION_SYNCHRONIZE event once the collection has retrieved the data above.

Disconnects this CollectionNode from the server. Typically used for garbage collection. If a node is subscribed but a network or services glitch causes it to disconnect, the CollectionNode will attempt to reconnect automatically.

Dispatched when a node within the collection has a change in its configuration (typically, its access-model).

Dispatched when a node within the collection receives an item.

Dispatched when a node within the collection retracts an item.

Dispatched when the current user's role changes for the collectionNode as a whole and not nodes within it. This event is more frequently useful than its more general counterpart, userRoleChange.

Dispatched when a node is created within the collection.

Dispatched when a node is deleted within the collection.

Dispatched when the collection has been disconnected from the server and is in the process of reconnecting and re-subscribing. A typical response to this event would be to reinitialize any shared parts of a model which depend on this collectionNode as the items will be re-received from the server. SYNCHRONIZATION_CHANGE will fire once this process completes.

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.

Dispatched when the collection or a node within the collection, has a change in roles for any user. This event is less frequently used than its more useful counterpart, myRoleChange. In general, this event is only useful for situations in which the individual nodes have roles assigned to them and where the developer cares about the roles of users other than the current user for these nodes.

When clearing a role at the CollectionNode or the node level, NO_EXPLICIT_ROLE is sent to the service to clear that role.