new ChangeRoomPasswordStateRequest(room, newPass)

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

This request not only changes the password of a Room, but also its "password state", which indicates if the Room is password protected or not.

If the operation is successful, the roomPasswordStateChange event is dispatched to all the users who subscribed the Group to which the target Room belongs, including the requester user himself. If the user is not the creator (owner) of the Room, the roomPasswordStateChangeError event is fired. An administrator or moderator can override this constrain (he is not requested to be the Room's owner).

If the Room was configured so that password change is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

Example

This example changes the password of an existing Room.

function someMethod()
{
	sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE, onRoomPasswordStateChanged, this);
	sfs.addEventListener(SFS2X.SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR, onRoomPasswordStateChangeError, this);

	var theRoom = sfs.getRoomByName("Gonzo's Room");
	sfs.send(new SFS2X.ChangeRoomPasswordStateRequest(theRoom, "mammamia"));
}

function onRoomPasswordStateChanged(evtParams)
{
	trace("The password of Room " + evtParams.room.name + " was changed successfully");
}

function onRoomPasswordStateChangeError(evtParams)
{
	trace("Room password change failed: " + evtParams.errorMessage);
}

Parameters

Name Type Optional Description

room

SFSRoom

 

The SFSRoom object corresponding to the Room whose password should be changed.

newPass

string

 

The new password to be assigned to the Room; an empty string or the null value can be passed to remove the Room's password.

See also
SmartFox#send
RoomSettings#permissions
SFSEvent.ROOM_PASSWORD_STATE_CHANGE
SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR