_server.sendGenericMessage()

Availability:

SmartFoxServer PRO 1.4.0

Usage:

_server.sendGenericMessage(xmlMsg, sender, recipientList)

Description:

This method can be used to send customized versions of the standard server messages. For example you may disable certain server responses and create a customized version of the same message in your extensions. An example could be a special version of the getRoomList() response etc...

Properties:

xmlMsg   the XML message
sender   the sender User objecy
recipientList   a list of users that should receive this message

Returns:

Nothing

Example:

/*
* Custom version of the rmList server response
* The server sends only the data relative to the room were we're currently logged in
*/
function sendSmallRoomList(r, who)
{
	var msg = "<msg t='sys'><body action='rmList' r='-1'>"
	
	msg += "<rmList><rm id='" + r.getId()
	msg += "' priv='" + (r.isPrivate() ? "1" : "0")
	msg += "' temp='" + (r.isTemp() ? "1" : "0")
	msg += "' game='" + (r.isGame() ? "1" : "0")
	msg += "' ucnt='" + (r.getUserCount())
	msg += "' maxu='" + r.getMaxUsers()
	msg += "' maxs='" + r.getMaxSpectator()
	msg += "'><n><![CDATA[" + r.getName() + "]]></n></rm></rmList>"

	msg += "</body></msg>"

	_server.sendGenericMessage(msg, null, [who])
}

See also: