Packagecom.worlize.api.event
Classpublic class RoomEvent
InheritanceRoomEvent Inheritance flash.events.Event

Product Version : Worlize APIv.1

Represents a variety of possible events that take place in the current room.



Public Properties
 PropertyDefined By
  roomObject : RoomObject
The object instance associated with the event.
RoomEvent
  user : User
The Worlize user associated with the event.
RoomEvent
Public Methods
 MethodDefined By
  
RoomEvent(type:String)
Constructor.
RoomEvent
Public Constants
 ConstantDefined By
  LOCKED : String = locked
[static] The RoomEvent.LOCKED constant defines the value of the type property of the event object for a locked event.
RoomEvent
  OBJECT_ADDED : String = objectAdded
[static] The RoomEvent.OBJECT_ADDED constant defines the value of the type property of the event object for a objectAdded event.
RoomEvent
  OBJECT_REMOVED : String = objectRemoved
[static] The RoomEvent.OBJECT_REMOVED constant defines the value of the type property of the event object for a objectRemoved event.
RoomEvent
  UNLOCKED : String = unlocked
[static] The RoomEvent.UNLOCKED constant defines the value of the type property of the event object for a unlocked event.
RoomEvent
  USER_ENTERED : String = userEntered
[static] The RoomEvent.USER_ENTERED constant defines the value of the type property of the event object for a userEntered event.
RoomEvent
  USER_LEFT : String = userLeft
[static] The RoomEvent.USER_LEFT constant defines the value of the type property of the event object for a userLeft event.
RoomEvent
Property Detail
roomObjectproperty
public var roomObject:RoomObject

Product Version : Worlize API.v1

The object instance associated with the event.

See also

userproperty 
public var user:User

Product Version : Worlize API.v1

The Worlize user associated with the event.

See also

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

Product Version : Worlize API.v1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
Constant Detail
LOCKEDConstant
public static const LOCKED:String = locked

Product Version : Worlize APIv.1

The RoomEvent.LOCKED constant defines the value of the type property of the event object for a locked 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 that locked the room. See com.worlize.api.model.User.

See also

OBJECT_ADDEDConstant 
public static const OBJECT_ADDED:String = objectAdded

Product Version : Worlize APIv.1

The RoomEvent.OBJECT_ADDED constant defines the value of the type property of the event object for a objectAdded 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.

See also

OBJECT_REMOVEDConstant 
public static const OBJECT_REMOVED:String = objectRemoved

Product Version : Worlize APIv.1

The RoomEvent.OBJECT_REMOVED constant defines the value of the type property of the event object for a objectRemoved 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.
roomObjectThe object associated with the event. See com.worlize.api.model.RoomObject.
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.

See also

UNLOCKEDConstant 
public static const UNLOCKED:String = unlocked

Product Version : Worlize APIv.1

The RoomEvent.UNLOCKED constant defines the value of the type property of the event object for a unlocked 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 that unlocked the room. See com.worlize.api.model.User.

See also

USER_ENTEREDConstant 
public static const USER_ENTERED:String = userEntered

Product Version : Worlize APIv.1

The RoomEvent.USER_ENTERED constant defines the value of the type property of the event object for a userEntered 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_LEFTConstant 
public static const USER_LEFT:String = userLeft

Product Version : Worlize APIv.1

The RoomEvent.USER_LEFT constant defines the value of the type property of the event object for a userLeft 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