Package sfs3.client.requests

Class ChangeRoomNameRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.ChangeRoomNameRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class ChangeRoomNameRequest
extends BaseRequest

Changes the name of a Room.

If the renaming operation is successful, the roomNameChange event is dispatched to all the users who subscribed the Group to which the target Room belongs, including the user who renamed it. If the user is not the creator (owner) of the Room the roomNameChangeError event if fired. An administrator or moderator can override the first constrain (he is not requested to be the Room's owner).

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

See Also:

• SFSEvent.ROOM_NAME_CHANGE
• SFSEvent.ROOM_NAME_CHANGE_ERROR
• RoomSettings.getPermissions()

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_NAME
static final String	KEY_ROOM

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
ChangeRoomNameRequest(Room room, String newName)	Creates a new ChangeRoomNameRequest 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 String KEY_NAME

Internal

Constructor Details

ChangeRoomNameRequest

public ChangeRoomNameRequest(Room room,
 String newName)

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

Parameters:

room - The Room object corresponding to the Room whose name should be changed.

newName - The new name to be assigned to the Room.

See Also:

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

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal