Packagecom.adobe.rtc.events
Classpublic class UserEvent
InheritanceUserEvent Inheritance flash.events.Event

UserEvent is the generic class pertaining to users. It is thrown by UserManager and (potentially) components for signalling changes to userDescriptors and roles.

See also

com.adobe.rtc.sharedManagers.descriptors.UserDescriptor
com.adobe.rtc.sharedManagers.UserManager


Public Properties
 PropertyDefined by
  userDescriptor : UserDescriptor
The userDescriptor of the affected user.
UserEvent
Public Methods
 MethodDefined by
  
UserEvent(p_type:String, p_descriptor:UserDescriptor = null, p_customFieldName:String = null)
UserEvent
Public Constants
 ConstantDefined by
  SYNCHRONIZATION_CHANGE : String = "synchronizationChange"
[static] Dispatched when the userManager loses connection or when it has finished reconnecting and synching to the room's state.
UserEvent
  USER_BOOTED : String = "userBooted"
[static] Dispatched when a user is forcibly ejected from the room.
UserEvent
  USER_CONNECTION_CHANGE : String = "userConnectionChange"
[static] Dispatched when the user's connection speed changes.
UserEvent
  USER_CREATE : String = "userCreate"
[static] Dispatched when a new user enters the room.
UserEvent
  USER_NAME_CHANGE : String = "userNameChange"
[static] Dispatched when the user displayName changes.
UserEvent
  USER_REMOVE : String = "userRemove"
[static] Dispatched when a user leaves the room.
UserEvent
  USER_ROLE_CHANGE : String = "userRoleChange"
[static] Dispatched when the user role changes.
UserEvent
  USER_STATUS_CHANGE : String = "userStatusChange"
[static] Dispatched when the status of a user changes.
UserEvent
  USER_USERICONURL_CHANGE : String = "userUsericonURLChange"
[static] Dispatched when the user avatar URL of a user changes.
UserEvent
  USER_VOICE_STATUS_CHANGE : String = "userVoiceStatusChange"
[static] Dispatched when the user is speaking or has stopped speaking.
UserEvent
Property detail
userDescriptorproperty
public var userDescriptor:UserDescriptor

The userDescriptor of the affected user.

Constructor detail
UserEvent()constructor
public function UserEvent(p_type:String, p_descriptor:UserDescriptor = null, p_customFieldName:String = null)Parameters
p_type:String
 
p_descriptor:UserDescriptor (default = null)
 
p_customFieldName:String (default = null)
Constant detail
SYNCHRONIZATION_CHANGEconstant
public static const SYNCHRONIZATION_CHANGE:String = "synchronizationChange"

Dispatched when the userManager loses connection or when it has finished reconnecting and synching to the room's state.

USER_BOOTEDconstant 
public static const USER_BOOTED:String = "userBooted"

Dispatched when a user is forcibly ejected from the room.

USER_CONNECTION_CHANGEconstant 
public static const USER_CONNECTION_CHANGE:String = "userConnectionChange"

Dispatched when the user's connection speed changes.

USER_CREATEconstant 
public static const USER_CREATE:String = "userCreate"

Dispatched when a new user enters the room.

USER_NAME_CHANGEconstant 
public static const USER_NAME_CHANGE:String = "userNameChange"

Dispatched when the user displayName changes.

USER_REMOVEconstant 
public static const USER_REMOVE:String = "userRemove"

Dispatched when a user leaves the room.

USER_ROLE_CHANGEconstant 
public static const USER_ROLE_CHANGE:String = "userRoleChange"

Dispatched when the user role changes.

USER_STATUS_CHANGEconstant 
public static const USER_STATUS_CHANGE:String = "userStatusChange"

Dispatched when the status of a user changes.

USER_USERICONURL_CHANGEconstant 
public static const USER_USERICONURL_CHANGE:String = "userUsericonURLChange"

Dispatched when the user avatar URL of a user changes.

USER_VOICE_STATUS_CHANGEconstant 
public static const USER_VOICE_STATUS_CHANGE:String = "userVoiceStatusChange"

Dispatched when the user is speaking or has stopped speaking.





 

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/events/UserEvent.html