new PrivateMessageRequest(message, recipientId[, params])

Creates a new PrivateMessageRequest instance. The instance must be passed to the SmartFox.send() method for the request to be executed.

Using this request a private message is dispatched to a specific user, who can be in any server Room, or even in no Room at all. The message is delivered by means of the privateMessage event. It is also returned to the sender: this allows showing the messages in the correct order in the application interface. It is also possible to send an optional object together with the message: it can contain custom parameters useful to transmit, for example, additional informations related to the message, like the text font or color, or other formatting details.

Example

This example sends a private message and handles the respective event.

function someMethod()
{
	sfs.addEventListener(SFS2X.SFSEvent.PRIVATE_MESSAGE, onPrivateMessage, this);

	// Send a private message to Jack
	var user = sfs.usermanager.getUserByName("Jack");
	sfs.send(new SFS2X.PrivateMessageRequest("Hello my friend!", user.id));
}

function onPrivateMessage(evtparams
{
	// As messages are forwarded to the sender too,
	// I have to check if I am the sender

	var sender = evtParams.sender;

	if (sender != sfs.mySelf)
		console.log("User " + sender.name + " sent me this PM: " + evtParams.message);
}

Parameters

Name Type Optional Description

message

string

 

The message to be sent to to the recipient user.

recipientId

number

 

The id of the user to which the message is to be sent.

params

SFSObject

Yes

A SFSObject containing additional custom parameters to be sent to the message recipient (for example the color of the text, etc).

Defaults to null.

See also
SmartFox#send
SFSEvent.PRIVATE_MESSAGE