Package	com.smartfoxserver.v2.requests
Class	public class JoinRoomRequest
Inheritance	JoinRoomRequest com.smartfoxserver.v2.requests.BaseRequest

Joins the current user in a Room.

If the operation is successful, the current user receives a roomJoin event; otherwise the roomJoinError event is fired. This usually happens when the Room is full, or the password is wrong in case of password protected Rooms.

Depending on the Room configuration defined upon its creation (see the RoomSettings.events setting), when the current user joins it, the following events might be fired: userEnterRoom, dispatched to the other users inside the Room to warn them that a new user has arrived; userCountChange, dispatched to all clients which subscribed the Group to which the Room belongs, to update the count of users inside the Room.

View the examples

See also

---

     
     private function someMethod():void
     {
         sfs.addEventListener(SFSEvent.ROOM_JOIN, onRoomJoined);
         sfs.addEventListener(SFSEvent.ROOM_JOIN_ERROR, onRoomJoinError);
         
         // Join a Room called "Lobby"
         sfs.send(new JoinRoomRequest("Lobby"));
     }
     
     private function onRoomJoined(evt:SFSEvent):void
     {
         trace("Room joined successfully: " + evt.params.room);
     }
     
     private function onRoomJoinError(evt:SFSEvent):void
     {
         trace("Room joining failed: " + evt.params.errorMessage);
     }