| Package | com.electrotank.electroserver5.api |
| Class | public class PublicMessageRequest |
| Inheritance | PublicMessageRequest EsRequest EsMessage flash.events.Event |
private var _es:ElectroServer;
private var _room:Room;
private function initialize():void {
_es.engine.addEventListener(MessageType.PublicMessageEvent.name, onPublicMessageEvent);
}
private function sendTestMessage():void {
//create the message object
var pmr:PublicMessageRequest = new PublicMessageRequest();
//configure it
pmr.message = "Hello World!";
pmr.roomId = _room.id;
pmr.zoneId = _room.zoneId;
//send it
_es.engine.send(pmr);
}
This shows how to send a public message to a room with an EsObject attached.
private var _es:ElectroServer;
private var _room:Room;
private function initialize():void {
_es.engine.addEventListener(MessageType.PublicMessageEvent.name, onPublicMessageEvent);
}
private function sendTestMessage():void {
//create the message object
var pmr:PublicMessageRequest = new PublicMessageRequest();
//configure it
pmr.message = "Hello World!";
pmr.roomId = _room.id;
pmr.zoneId = _room.zoneId;
//create an EsObject to send
var esob:EsObject = new EsObject();
esob.setBoolean("playAudioWithMessage", true);
//put it on the message
pmr.esObject = esob;
//send it
_es.engine.send(pmr);
}
private function onPublicMessageEvent(e:PublicMessageEvent):void {
trace(e.userName + " says '" + e.message + "'");
trace("playAudioWithMessage: " + e.esObject.getBoolean("playAudioWithMessage").toString());
}
| Property | Defined By | ||
|---|---|---|---|
| esObject : EsObject
An optional EsObject to send with the message. | PublicMessageRequest | ||
| message : String
The message to send. | PublicMessageRequest | ||
![]() | messageNumber : int | EsMessage | |
![]() | messageType : MessageType | EsMessage | |
![]() | requestId : int | EsMessage | |
| roomId : int
The id of the target room for the message
| PublicMessageRequest | ||
![]() | serverId : String | EsMessage | |
| zoneId : int
Id of the zone that contains the room
| PublicMessageRequest | ||
| Method | Defined By | ||
|---|---|---|---|
PublicMessageRequest(m:MessageType = null, t:TBase = null) | PublicMessageRequest | ||
fromThrift(t_:TBase):void [override] | PublicMessageRequest | ||
newThrift():TBase [override] | PublicMessageRequest | ||
toThrift():TBase [override] | PublicMessageRequest | ||
| esObject | property |
esObject:EsObjectAn optional EsObject to send with the message.
public function get esObject():EsObject public function set esObject(value:EsObject):void| message | property |
message:StringThe message to send.
public function get message():String public function set message(value:String):void| roomId | property |
roomId:intThe id of the target room for the message
public function get roomId():int public function set roomId(value:int):void| zoneId | property |
zoneId:intId of the zone that contains the room
public function get zoneId():int public function set zoneId(value:int):void| PublicMessageRequest | () | Constructor |
public function PublicMessageRequest(m:MessageType = null, t:TBase = null)m:MessageType (default = null) | |
t:TBase (default = null) |
| fromThrift | () | method |
override public function fromThrift(t_:TBase):voidParameters
t_:TBase |
| newThrift | () | method |
override public function newThrift():TBaseReturnsTBase |
| toThrift | () | method |
override public function toThrift():TBaseReturnsTBase |