Packagecom.adobe.rtc.sharedModel.userQueueClasses
Classpublic class UserQueueItem
ImplementsIValueObjectEncodable

UserQueueItem is a "descriptor" for describing the properties of a user request in a UserQueue.

See also

com.adobe.rtc.sharedModel.UserQueue


Public Properties
 PropertyDefined by
  dealtBy : String
Who affected the status of this UserQueueItem?
UserQueueItem
  descriptor : Object
The object that describes information about the queueitem
UserQueueItem
  message : String
The optional message that came along with the request.
UserQueueItem
  position : int = -1
The position in the queue of this UserQueueItem.
UserQueueItem
  response : String
The optional response that came along with the accept, deny, or cancel request.
UserQueueItem
  status : int = 0
The status of this UserQueueItem.
UserQueueItem
  userID : String
Who posted this request?
UserQueueItem
Public Methods
 MethodDefined by
  
Creates a ValueObject representation of this MessageItem.
UserQueueItem
  
readValueObject(p_valueObject:Object):void
Takes in a valueObject and structure the MessageItem according to the values therein.
UserQueueItem
Public Constants
 ConstantDefined by
  STATUS_ACCEPTED : int = 1
[static] Requests are accepted when a queue manager accepts them.
UserQueueItem
  STATUS_CANCELED : int = 3
[static] Requests are canceled when a user cancels it or a queue manager cancels it for them.
UserQueueItem
  STATUS_DENIED : int = 2
[static] Requests are denied when a queue manager denies them.
UserQueueItem
  STATUS_PENDING : int = 0
[static] Requests are pending when a queue manager hasn't dealt with them yet.
UserQueueItem
Property detail
dealtByproperty
public var dealtBy:String

Who affected the status of this UserQueueItem?

descriptorproperty 
public var descriptor:Object

The object that describes information about the queueitem

messageproperty 
public var message:String

The optional message that came along with the request.

positionproperty 
public var position:int = -1

The position in the queue of this UserQueueItem.

responseproperty 
public var response:String

The optional response that came along with the accept, deny, or cancel request.

statusproperty 
public var status:int = 0

The status of this UserQueueItem.

userIDproperty 
public var userID:String

Who posted this request?

Method detail
createValueObject()method
public function createValueObject():Object

Creates a ValueObject representation of this MessageItem.

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

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

Parameters
p_valueObject:Object — An Object which represents the non-default values for this MessageItem.
Constant detail
STATUS_ACCEPTEDconstant
public static const STATUS_ACCEPTED:int = 1

Requests are accepted when a queue manager accepts them. Look at the dealtBy userID to see who accepted the request.

STATUS_CANCELEDconstant 
public static const STATUS_CANCELED:int = 3

Requests are canceled when a user cancels it or a queue manager cancels it for them. Look at the dealtBy userID to see who canceled the request.

STATUS_DENIEDconstant 
public static const STATUS_DENIED:int = 2

Requests are denied when a queue manager denies them. Look at the dealtBy userID to see who denied the request.

STATUS_PENDINGconstant 
public static const STATUS_PENDING:int = 0

Requests are pending when a queue manager hasn't dealt with them yet. Requests start in this status.





 

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/sharedModel/userQueueClasses/UserQueueItem.html