Electrotank.Electroserver5.Api.PrivateMessageEvent Class Reference

This event occurs when a client receives a private message from another user. More...

Inheritance diagram for Electrotank.Electroserver5.Api.PrivateMessageEvent:

Public Member Functions
	PrivateMessageEvent ()
	PrivateMessageEvent (TBase t)
override TBase	ToThrift ()
override TBase	NewThrift ()
override void	FromThrift (TBase t_)
Public Member Functions inherited from Electrotank.Electroserver5.Api.EsEvent
	EsEvent ()

Properties
string	UserName [get, set]
	Name of the user that sent the message. More...
string	Message [get, set]
	The chat message. More...
EsObject	EsObject [get, set]
	Optional EsObject that was sent with the message. More...

Detailed Description

This event occurs when a client receives a private message from another user.

The event object contains the name of the user that sent it, the message, and an optional EsObject.

      This shows how to send a private message to one user and capture an event when one is received.

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);
}

Constructor & Destructor Documentation

Electrotank.Electroserver5.Api.PrivateMessageEvent.PrivateMessageEvent

(

)

Electrotank.Electroserver5.Api.PrivateMessageEvent.PrivateMessageEvent

(

TBase

t

)

Member Function Documentation

override void Electrotank.Electroserver5.Api.PrivateMessageEvent.FromThrift ( TBase  t_ )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

override TBase Electrotank.Electroserver5.Api.PrivateMessageEvent.NewThrift ( )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

override TBase Electrotank.Electroserver5.Api.PrivateMessageEvent.ToThrift ( )

virtual

Implements Electrotank.Electroserver5.Api.EsMessage.

Property Documentation

EsObject Electrotank.Electroserver5.Api.PrivateMessageEvent.EsObject

getset

Optional EsObject that was sent with the message.

string Electrotank.Electroserver5.Api.PrivateMessageEvent.Message

getset

The chat message.

string Electrotank.Electroserver5.Api.PrivateMessageEvent.UserName

getset

Name of the user that sent the message.