Class SFS2X.Requests.System.PrivateMessageRequest
Sends a private chat message.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
SFS2X.Requests.System.PrivateMessageRequest(message, recipientId, params)
Creates a new PrivateMessageRequest instance.
|
Class Detail
SFS2X.Requests.System.PrivateMessageRequest(message, recipientId, params)
Creates a new PrivateMessageRequest instance.
The instance must be passed to the SmartFox.send() method for the request to be performed.
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.
The following 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.Requests.System.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:
- {String} message
- The message to be sent to to the recipient user.
- {Number} recipientId
- The id of the user to which the message is to be sent.
- {Object} params Optional, Default: null
- An object containing additional custom parameters to be sent to the message recipient (for example the color of the text, etc).