SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
JoinRoomRequest Class Reference

#import <JoinRoomRequest.h>

Inherits BaseRequest.

Class Methods

(id) + requestWithId:pass:roomIdToLeave:asSpect:
 
(id) + requestWithId:
 

Detailed Description

Join the current User in a Room.

Method Documentation

◆ requestWithId:pass:roomIdToLeave:asSpect:

+ (id) requestWithId: (id)  numericIdOrName
pass: (NSString *)  pass
roomIdToLeave: (NSNumber *)  roomIdToLeave
asSpect: (BOOL)  asSpect 
Parameters
numericIdOrNameyou can use the numeric ID of the Room or its name (you need to pass numeric id in a NSNumber object)
passneeded only if the Room is password protected
roomIdToLeavethe id of a previously joined Room that you want to leave once joined in the new Room (optional). The default behavior is to leave the previous Room. You can pass a negative ID to avoid leaving any Room
asSpectif true it indicates that you want to join the room as spectator (optional, for game Rooms only)
See also
[ISFSEvents onRoomJoin:]
[ISFSEvents onRoomJoinError:]
LeaveRoomRequest