Packagecom.electrotank.electroserver5.api
Classpublic class PrivateMessageRequest
InheritancePrivateMessageRequest Inheritance EsRequest Inheritance EsMessage Inheritance flash.events.Event

This request is used to send private messages to one or more users at once. A private message can contain an optional EsObject. A private message can be sent from any user to any other user. Rooms play no part in this. Private messages can be intercepted by a Private Message Event Handler on the server and modified or killed. Private message filtering can be enabled using the web-based administrator. This shows how to send a private message to one user. It also shows how to capture the PrivateMessageEvent.
private var _es:ElectroServer;
private function initialize():void {
        _es.engine.addEventListener(MessageType.PrivateMessageEvent.name, onPrivateMessageEvent);
}
private function onPrivateMessageEvent(e:PrivateMessageEvent):void {
        trace(e.userName + " says '" + e.message + "'");
}
private function sendTestMessage():void {
        //create the message object
        var pmr:PrivateMessageRequest = new PrivateMessageRequest();
        //configure it
        pmr.message = "Hello World!";
        pmr.userNames = ["frank"];
        //send it
        _es.engine.send(pmr);
}



Public Properties
 PropertyDefined By
  esObject : EsObject
Optional EsObject to be sent with the message.
PrivateMessageRequest
  message : String
The message to send.
PrivateMessageRequest
 InheritedmessageNumber : int
EsMessage
 InheritedmessageType : MessageType
EsMessage
 InheritedrequestId : int
EsMessage
 InheritedserverId : String
EsMessage
  userNames : Array
List of user names specifying show should receive the message.
PrivateMessageRequest
Public Methods
 MethodDefined By
  
PrivateMessageRequest(m:MessageType = null, t:TBase = null)
PrivateMessageRequest
  
fromThrift(t_:TBase):void
[override]
PrivateMessageRequest
  
newThrift():TBase
[override]
PrivateMessageRequest
  
toThrift():TBase
[override]
PrivateMessageRequest
Property Detail
esObjectproperty
esObject:EsObject

Optional EsObject to be sent with the message.


Implementation
    public function get esObject():EsObject
    public function set esObject(value:EsObject):void
messageproperty 
message:String

The message to send.


Implementation
    public function get message():String
    public function set message(value:String):void
userNamesproperty 
userNames:Array

List of user names specifying show should receive the message.


Implementation
    public function get userNames():Array
    public function set userNames(value:Array):void
Constructor Detail
PrivateMessageRequest()Constructor
public function PrivateMessageRequest(m:MessageType = null, t:TBase = null)



Parameters
m:MessageType (default = null)
 
t:TBase (default = null)
Method Detail
fromThrift()method
override public function fromThrift(t_:TBase):void

Parameters

t_:TBase

newThrift()method 
override public function newThrift():TBase

Returns
TBase
toThrift()method 
override public function toThrift():TBase

Returns
TBase