onPrivateMessage()

Availability:

Flash Player 7, 8
SmartFoxServer Lite / Basic / Pro

Usage:

smartFox.onPrivateMessage(msg:String, sender:User) ( until version 1.4.x )
smartFox.onPrivateMessage(msg:String, sender:User, userId:Number, roomId:Number) ( from version 1.5.x )

Description:

The event is fired when a private chat message is received.

Parameters:

msg   the text message
sender   the user object representing the client who sent the message
userId   id of the sender user
roomId   id of the room where the message was originated

Check the User Class for more info on the objects returned.

Returns:

nothing

Example:

smartFox.onPrivateMessage = function(msg:String, sender:User)
{
	trace("A private message from " + sender.getName() + " has arrived: " + msg) 
}

See also: