| Package | com.adobe.rtc.messaging |
| Class | public class NodeConfiguration |
| Implements | IValueObjectEncodable |
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
| Property | Defined 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 | ||
| modifyAnyItem : Boolean
Whether or not publishers may modify other users' stored items on the node (true) or only
MessageItems they have published (false).
| 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 | ||
| Method | Defined 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)
| NodeConfiguration | ||
| NodeConfiguration | |||
|
createValueObject():Object
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 | ||
| Constant | Defined 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 | ||
| accessModel | property |
public var accessModel:intThe minimum role value required to subscribe to the node and receive MessageItems.
See also
| allowPrivateMessages | property |
public var allowPrivateMessages:BooleanWhether or not private messages are allowed.
The default value is false.
| itemStorageScheme | property |
public var itemStorageScheme:intStorage scheme for the MessageItems sent over this node. It is one of the STORAGE_SCHEME constants listed.
| modifyAnyItem | property |
public var modifyAnyItem:BooleanWhether 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.
| persistItems | property |
public var persistItems:BooleanWhether or not MessageItems should be stored and forwarded to users arriving later (true) or not stored at all (false).
The default value is true.
| publishModel | property |
public var publishModel:intThe minimum role value required to publish MessageItems to the node.
See also
| sessionDependentItems | property |
public var sessionDependentItems:BooleanWhether 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.
| userDependentItems | property |
public var userDependentItems:BooleanWhether or not stored MessageItems should be retracted from the server when their sender leaves the room (true) or left until manually retracted (false).
| 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)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) |
| clone | () | method |
| createValueObject | () | method |
public function createValueObject():ObjectCreates a ValueObject representation of this NodeConfiguration.
ReturnsObject — 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.
p_valueObject:Object — An Object which represents the non-default values for this NodeConfiguration.
|
| DEFAULT_CONFIGURATION | constant |
public static const DEFAULT_CONFIGURATION:NodeConfigurationA constant for storing the default configuration of a node.
| STORAGE_SCHEME_MANUAL | constant |
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_QUEUE | constant |
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_ITEM | constant |
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