Packagecom.worlize.api.event
Classpublic class UserEvent
InheritanceUserEvent Inheritance flash.events.Event

Product Version : Worlize APIv.1

Represents events that relate to a user in the current room.



Public Properties
 PropertyDefined By
  user : User
The user associated with the current event.
UserEvent
Public Methods
 MethodDefined By
  
UserEvent(type:String)
Constructor.
UserEvent
Public Constants
 ConstantDefined By
  USER_AVATAR_CHANGED : String = userAvatarChanged
[static] The UserEvent.USER_AVATAR_CHANGED constant defines the value of the type property of the event object for a userAvatarChanged event.
UserEvent
  USER_BALLOON_COLOR_CHANGED : String = userBalloonColorChanged
[static] The UserEvent.USER_BALLOON_COLOR_CHANGED constant defines the value of the type property of the event object for a userBalloonColorChanged event.
UserEvent
  USER_COLOR_CHANGED : String = userColorChanged
[static] The UserEvent.USER_COLOR_CHANGED constant defines the value of the type property of the event object for a userColorChanged event.
UserEvent
  USER_MOVED : String = userMoved
[static] The UserEvent.USER_MOVED constant defines the value of the type property of the event object for a userMoved event.
UserEvent
  USER_PRIVILEGES_CHANGED : String = userPrivilegesChanged
[static] The UserEvent.USER_PRIVILEGES_CHANGED constant defines the value of the type property of the event object for a userPrivilegesChanged event.
UserEvent
Property Detail
userproperty
public var user:User

Product Version : Worlize API.v1

The user associated with the current event.

See also

Constructor Detail
UserEvent()Constructor
public function UserEvent(type:String)

Product Version : Worlize API.v1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
Constant Detail
USER_AVATAR_CHANGEDConstant
public static const USER_AVATAR_CHANGED:String = userAvatarChanged

Product Version : Worlize APIv.1

The UserEvent.USER_AVATAR_CHANGED constant defines the value of the type property of the event object for a userAvatarChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.

See also

USER_BALLOON_COLOR_CHANGEDConstant 
public static const USER_BALLOON_COLOR_CHANGED:String = userBalloonColorChanged

Product Version : Worlize APIv.1

The UserEvent.USER_BALLOON_COLOR_CHANGED constant defines the value of the type property of the event object for a userBalloonColorChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.

See also

USER_COLOR_CHANGEDConstant 
public static const USER_COLOR_CHANGED:String = userColorChanged

Product Version : Worlize APIv.1

The UserEvent.USER_COLOR_CHANGED constant defines the value of the type property of the event object for a userColorChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.

See also

USER_MOVEDConstant 
public static const USER_MOVED:String = userMoved

Product Version : Worlize APIv.1

The UserEvent.USER_MOVED constant defines the value of the type property of the event object for a userMoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.

See also

USER_PRIVILEGES_CHANGEDConstant 
public static const USER_PRIVILEGES_CHANGED:String = userPrivilegesChanged

Product Version : Worlize APIv.1

The UserEvent.USER_PRIVILEGES_CHANGED constant defines the value of the type property of the event object for a userPrivilegesChanged event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
userThe user associated with the event. See com.worlize.api.model.User.

See also