Class: LeaveRoomRequest

LeaveRoomRequest

Leaves one of the Rooms joined by the User.

Depending on the Room configuration (set when it was created - see the RoomSettings#events setting), when the current User leaves the Room, the following events may be fired: SFSEvent.USER_EXIT_ROOM, dispatched to all the Users inside the Room (including the current User) to warn them that a User is gone; SFSEvent.USER_COUNT_CHANGE, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of Users inside the Room.

Constructor

new LeaveRoomRequest(roomopt)

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

Parameters:

Name	Type	Attributes	Default	Description
`room`	SFSRoom	<optional>	null	The object representing the Room that the User wants to leave; if `null`, the last Room joined by the client is left.

See: BanUserRequest

Fires:

SFSEvent#event:USER_EXIT_ROOM
SFSEvent#event:USER_COUNT_CHANGE