Packagecom.adobe.rtc.messaging
Classpublic class NodeConfiguration
ImplementsIValueObjectEncodable

NodeConfiguration is a "descriptor" for describing the properties of a node's configuration. See Example 129 of XEP-60's pubsub functionality. http://www.xmpp.org/extensions/xep-0060.html
This class describes the subset of and additions to the set of configuration options supported in LCCS.

Within each CollectionNode is a series of one or more nodes. A node is a channel through which to send and receive MessageItems. Nodes are also configured according to rules concerning what UserRoles may publish and subscribe MessageItems through them, as well as other policies concering message storage and privacy. NodeConfigurations are used to set these policies.

For more information, refer to the Developer Guide's "Messaging and Permissions" chapter.

See also

com.adobe.rtc.sharedModel.CollectionNode
com.adobe.rtc.messaging.MessageItem
com.adobe.rtc.messaging.UserRoles


Public Properties
 PropertyDefined by
  accessModel : int
The minimum role value required to subscribe to the node and receive MessageItems.
NodeConfiguration
  allowPrivateMessages : Boolean
Whether or not private messages are allowed.
NodeConfiguration
  itemStorageScheme : int
Storage scheme for the MessageItems sent over this node.
NodeConfiguration
  lazySubscription : Boolean
Whether or not the subscription to this node is "lazy" - that is, it doesn't receive items automatically.
NodeConfiguration
  modifyAnyItem : Boolean
Whether or not publishers may modify other users' stored items on the node (true) or only MessageItems they have published (false).
NodeConfiguration
  p2pDataMessaging : Boolean
Whether or not p2p data messaging on this collection is allowed.
NodeConfiguration
  persistItems : Boolean
Whether or not MessageItems should be stored and forwarded to users arriving later (true) or not stored at all (false).
NodeConfiguration
  publishModel : int
The minimum role value required to publish MessageItems to the node.
NodeConfiguration
  sessionDependentItems : Boolean
Whether or not stored MessageItems should be retracted from the server when meeting session ends (true) or left until manually retracted (false).
NodeConfiguration
  userDependentItems : Boolean
Whether or not stored MessageItems should be retracted from the server when their sender leaves the room (true) or left until manually retracted (false).
NodeConfiguration
Public Methods
 MethodDefined by
  
NodeConfiguration(p_accessModel:int = 10, p_publishModel:int = 50, p_persistItems:Boolean = true, p_modifyAnyItem:Boolean = true, p_userDependentItems:Boolean = false, p_sessionDependentItems:Boolean = false, p_storageScheme:int, p_allowPrivateMessages:Boolean = false, p_lazySubscription:Boolean = false, p_p2pDataMessaging:Boolean = false)
NodeConfiguration
  
NodeConfiguration
  
Creates a ValueObject representation of this NodeConfiguration.
NodeConfiguration
  
readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the NodeConfiguration according to the values therein.
NodeConfiguration
Public Constants
 ConstantDefined by
  DEFAULT_CONFIGURATION : NodeConfiguration
[static] A constant for storing the default configuration of a node.
NodeConfiguration
  STORAGE_SCHEME_MANUAL : uint = 2
[static] The storage scheme to enable manual management of itemIDs for each MessageItem.
NodeConfiguration
  STORAGE_SCHEME_QUEUE : uint = 1
[static] The storage scheme to enable storage of a queue of MessageItems.
NodeConfiguration
  STORAGE_SCHEME_SINGLE_ITEM : uint = 0
[static] The storage scheme if a node is to only store and update one MessageItem.
NodeConfiguration
Property detail
accessModelproperty
public var accessModel:int

The minimum role value required to subscribe to the node and receive MessageItems.

See also

allowPrivateMessagesproperty 
public var allowPrivateMessages:Boolean

Whether or not private messages are allowed.

The default value is false.

itemStorageSchemeproperty 
public var itemStorageScheme:int

Storage scheme for the MessageItems sent over this node. It is one of the STORAGE_SCHEME constants listed.

lazySubscriptionproperty 
public var lazySubscription:Boolean

Whether or not the subscription to this node is "lazy" - that is, it doesn't receive items automatically. For fetching items from a node with lazySubscription, use collectionNode.fetchItems()

modifyAnyItemproperty 
public var modifyAnyItem:Boolean

Whether or not publishers may modify other users' stored items on the node (true) or only MessageItems they have published (false).

The default value is true.

p2pDataMessagingproperty 
public var p2pDataMessaging:Boolean

Whether or not p2p data messaging on this collection is allowed. Users need to set this property to true programmatically or using dev console UI to allow p2p data messaging.

The default value is false.

persistItemsproperty 
public var persistItems:Boolean

Whether or not MessageItems should be stored and forwarded to users arriving later (true) or not stored at all (false).

The default value is true.

publishModelproperty 
public var publishModel:int

The minimum role value required to publish MessageItems to the node.

See also

sessionDependentItemsproperty 
public var sessionDependentItems:Boolean

Whether or not stored MessageItems should be retracted from the server when meeting session ends (true) or left until manually retracted (false).

The default value is false.

userDependentItemsproperty 
public var userDependentItems:Boolean

Whether or not stored MessageItems should be retracted from the server when their sender leaves the room (true) or left until manually retracted (false).

Constructor detail
NodeConfiguration()constructor
public function NodeConfiguration(p_accessModel:int = 10, p_publishModel:int = 50, p_persistItems:Boolean = true, p_modifyAnyItem:Boolean = true, p_userDependentItems:Boolean = false, p_sessionDependentItems:Boolean = false, p_storageScheme:int, p_allowPrivateMessages:Boolean = false, p_lazySubscription:Boolean = false, p_p2pDataMessaging:Boolean = false)Parameters
p_accessModel:int (default = 10)
 
p_publishModel:int (default = 50)
 
p_persistItems:Boolean (default = true)
 
p_modifyAnyItem:Boolean (default = true)
 
p_userDependentItems:Boolean (default = false)
 
p_sessionDependentItems:Boolean (default = false)
 
p_storageScheme:int
 
p_allowPrivateMessages:Boolean (default = false)
 
p_lazySubscription:Boolean (default = false)
 
p_p2pDataMessaging:Boolean (default = false)
Method detail
clone()method
public function clone():NodeConfiguration

Returns
NodeConfiguration
createValueObject()method 
public function createValueObject():Object

Creates a ValueObject representation of this NodeConfiguration.

Returns
Object — An Object which represents the non-default values for this NodeConfiguration suitable for consumption by readValueObject.
readValueObject()method 
public function readValueObject(p_valueObject:Object):void

Takes in a valueObject and structure the NodeConfiguration according to the values therein.

Parameters
p_valueObject:Object — An Object which represents the non-default values for this NodeConfiguration.
Constant detail
DEFAULT_CONFIGURATIONconstant
public static const DEFAULT_CONFIGURATION:NodeConfiguration

A constant for storing the default configuration of a node.

STORAGE_SCHEME_MANUALconstant 
public static const STORAGE_SCHEME_MANUAL:uint = 2

The storage scheme to enable manual management of itemIDs for each MessageItem. It allows the node to behave as if it were a hash table.

STORAGE_SCHEME_QUEUEconstant 
public static const STORAGE_SCHEME_QUEUE:uint = 1

The storage scheme to enable storage of a queue of MessageItems. Items will have their itemIDs start at 0 and continue to auto-increment.

STORAGE_SCHEME_SINGLE_ITEMconstant 
public static const STORAGE_SCHEME_SINGLE_ITEM:uint = 0

The storage scheme if a node is to only store and update one MessageItem. The item will be given the itemID "item" by default.





 

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/messaging/NodeConfiguration.html