Packagecom.worlize.api.event
Classpublic class MessageEvent
InheritanceMessageEvent Inheritance flash.events.Event

Product Version : Worlize APIv.1

Represents inter-object messaging events.



Public Properties
 PropertyDefined By
  fromObject : RoomObject
The object (app) that sent the message
MessageEvent
  fromUser : User
The user who sent the message
MessageEvent
  message : Object
The AMF3-deserialized object received
MessageEvent
Public Methods
 MethodDefined By
  
MessageEvent(type:String)
Constructor.
MessageEvent
Public Constants
 ConstantDefined By
  MESSAGE_RECEIVED : String = messageReceived
[static] The MessageEvent.MESSAGE_RECEIVED constant defines the value of the type property of the event object for a messageReceived event.
MessageEvent
Property Detail
fromObjectproperty
public var fromObject:RoomObject

Product Version : Worlize API.v1

The object (app) that sent the message

See also

fromUserproperty 
public var fromUser:User

Product Version : Worlize API.v1

The user who sent the message

See also

messageproperty 
public var message:Object

Product Version : Worlize API.v1

The AMF3-deserialized object received

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

Product Version : Worlize API.v1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
Constant Detail
MESSAGE_RECEIVEDConstant
public static const MESSAGE_RECEIVED:String = messageReceived

Product Version : Worlize APIv.1

The MessageEvent.MESSAGE_RECEIVED constant defines the value of the type property of the event object for a messageReceived 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.
fromUserThe user who sent the message. See com.worlize.api.model.User.
fromObjectThe object that sent the message. See com.worlize.api.model.RoomObject.
messageThe message received.
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