Package sfs3.client.requests

Class CreateRoomRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.CreateRoomRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class CreateRoomRequest
extends BaseRequest

Creates a new Room in the current Zone.

If the creation is successful, a roomAdd event is dispatched to all the users who subscribed the Group to which the Room is associated, including the Room creator. Otherwise, a roomCreationError event is returned to the creator's client.

See Also:

• SFSEvent.ROOM_ADD
• SFSEvent.ROOM_CREATION_ERROR

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ALLOW_JOIN_INVITATION_BY_OWNER
static final String	KEY_AUTOJOIN
static final String	KEY_EVENTS
static final String	KEY_EXTCLASS
static final String	KEY_EXTID
static final String	KEY_EXTPROP
static final String	KEY_GROUP_ID
static final String	KEY_ISGAME
static final String	KEY_MAXSPECTATORS
static final String	KEY_MAXUSERS
static final String	KEY_MAXVARS
static final String	KEY_MMO_DEFAULT_AOI
static final String	KEY_MMO_MAP_HIGH_LIMIT
static final String	KEY_MMO_MAP_LOW_LIMIT
static final String	KEY_MMO_PROXIMITY_UPDATE_MILLIS
static final String	KEY_MMO_SEND_ENTRY_POINT
static final String	KEY_MMO_USER_MAX_LIMBO_SECONDS
static final String	KEY_NAME
static final String	KEY_PASSWORD
static final String	KEY_PERMISSIONS
static final String	KEY_ROOM
static final String	KEY_ROOM_TO_LEAVE
static final String	KEY_ROOMVARS

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
CreateRoomRequest(RoomSettings settings)
CreateRoomRequest(RoomSettings settings, boolean autoJoin)
CreateRoomRequest(RoomSettings settings, boolean autoJoin, Room roomToLeave)	Creates a new CreateRoomRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

Internal

KEY_NAME

public static final String KEY_NAME

See Also:

• Constant Field Values

Internal

KEY_PASSWORD

public static final String KEY_PASSWORD

See Also:

• Constant Field Values

Internal

KEY_GROUP_ID

public static final String KEY_GROUP_ID

See Also:

• Constant Field Values

Internal

KEY_ISGAME

public static final String KEY_ISGAME

See Also:

• Constant Field Values

Internal

KEY_MAXUSERS

public static final String KEY_MAXUSERS

See Also:

• Constant Field Values

Internal

KEY_MAXSPECTATORS

public static final String KEY_MAXSPECTATORS

See Also:

• Constant Field Values

Internal

KEY_MAXVARS

public static final String KEY_MAXVARS

See Also:

• Constant Field Values

Internal

KEY_ROOMVARS

public static final String KEY_ROOMVARS

See Also:

• Constant Field Values

Internal

KEY_PERMISSIONS

public static final String KEY_PERMISSIONS

See Also:

• Constant Field Values

Internal

KEY_EVENTS

public static final String KEY_EVENTS

See Also:

• Constant Field Values

Internal

KEY_EXTID

public static final String KEY_EXTID

See Also:

• Constant Field Values

Internal

KEY_EXTCLASS

public static final String KEY_EXTCLASS

See Also:

• Constant Field Values

Internal

KEY_EXTPROP

public static final String KEY_EXTPROP

See Also:

• Constant Field Values

Internal

KEY_AUTOJOIN

public static final String KEY_AUTOJOIN

See Also:

• Constant Field Values

Internal

KEY_ROOM_TO_LEAVE

public static final String KEY_ROOM_TO_LEAVE

See Also:

• Constant Field Values

Internal

KEY_ALLOW_JOIN_INVITATION_BY_OWNER

public static final String KEY_ALLOW_JOIN_INVITATION_BY_OWNER

See Also:

• Constant Field Values

Internal

KEY_MMO_DEFAULT_AOI

public static final String KEY_MMO_DEFAULT_AOI

See Also:

• Constant Field Values

Internal

KEY_MMO_MAP_LOW_LIMIT

public static final String KEY_MMO_MAP_LOW_LIMIT

See Also:

• Constant Field Values

Internal

KEY_MMO_MAP_HIGH_LIMIT

public static final String KEY_MMO_MAP_HIGH_LIMIT

See Also:

• Constant Field Values

Internal

KEY_MMO_USER_MAX_LIMBO_SECONDS

public static final String KEY_MMO_USER_MAX_LIMBO_SECONDS

See Also:

• Constant Field Values

Internal

KEY_MMO_PROXIMITY_UPDATE_MILLIS

public static final String KEY_MMO_PROXIMITY_UPDATE_MILLIS

See Also:

• Constant Field Values

Internal

KEY_MMO_SEND_ENTRY_POINT

public static final String KEY_MMO_SEND_ENTRY_POINT

See Also:

• Constant Field Values

Internal

Constructor Details

CreateRoomRequest

public CreateRoomRequest(RoomSettings settings,
 boolean autoJoin,
 Room roomToLeave)

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

Parameters:

settings - An object containing the Room configuration settings.

autoJoin - If true, the Room is joined as soon as it is created.

roomToLeave - A Room object representing the Room that should be left if the new Room is auto-joined.

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• RoomSettings
• Room

CreateRoomRequest

public CreateRoomRequest(RoomSettings settings,
 boolean autoJoin)

See Also:

• CreateRoomRequest(RoomSettings, boolean, Room)

CreateRoomRequest

public CreateRoomRequest(RoomSettings settings)

See Also:

• CreateRoomRequest(RoomSettings, boolean, Room)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal