Class: ChangeRoomNameRequest

ChangeRoomNameRequest

Changes the name of a Room.

If the renaming operation is successful, the SFSEvent.ROOM_NAME_CHANGE event is dispatched to all the Users which subscribed the Group to which the target Room belongs, including the User which renamed it. If the User is not the creator (owner) of the Room, or if the new name doesn't match the related criteria in Zone configuration, the SFSEvent.ROOM_NAME_CHANGE_ERROR event is fired. An administrator or moderator can override this constrain (doesn't need to be the Room's owner).

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

Constructor

new ChangeRoomNameRequest(room, newName)

Creates a new instance of the ChangeRoomNameRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.

Parameters:

Name	Type	Description
`room`	SFSRoom	The object representing the Room whose name should be changed.
`newName`	string	The new name of the Room.

See: RoomSettings#permissions

Fires: