sfs2x.client.requests
Class ChangeRoomNameRequest

java.lang.Object
  sfs2x.client.requests.BaseRequest
      sfs2x.client.requests.ChangeRoomNameRequest

All Implemented Interfaces:

sfs2x.client.requests.IRequest

public class ChangeRoomNameRequest
extends sfs2x.client.requests.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, or if the Room was configured so that renaming is not allowed (see the RoomSettings.permissions parameter), the roomNameChangeError event if fired. An administrator or moderator can override the first constrain (he is not requested to be the Room's owner).

Example
The following example renames an existing Room:

private void someMethod() { sfs.addEventListener(SFSEvent.ROOM_NAME_CHANGE, new IEventListener() { public void dispatch(BaseEvent evt) throws SFSException { System.out.println("Room " + evt.getArguments().get("oldName") + " was successfully renamed to " + ((Room)evt.getArguments().get("room")).getName()); } });

sfs.addEventListener(SFSEvent.ROOM_NAME_CHANGE_ERROR, new IEventListener() { public void dispatch(BaseEvent evt) throws SFSException { System.out.println("Room name change failed: " + evt.getArguments().get("errorMessage")); } });

Room theRoom = sfs.getRoomByName("Gonzo's Room");

// Resize the Room so that it allows a maximum of 100 users and zero spectators sfs.send(new ChangeRoomNameRequest(theRoom, "Gonzo The Great's Room")); }

See Also:

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

Field Summary

static java.lang.String	KEY_NAME *Private*
static java.lang.String	KEY_ROOM *Private*

Fields inherited from class sfs2x.client.requests.BaseRequest

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

Constructor Summary

ChangeRoomNameRequest(Room room, java.lang.String newName)
Creates a new ChangeRoomNameRequest instance.

Method Summary

void	execute(SmartFox sfs) *Private*
void	validate(SmartFox sfs) *Private*

Methods inherited from class sfs2x.client.requests.BaseRequest

getId, getMessage, getTargetController, isEncrypted, setEncrypted, setId, setTargetController

Methods inherited from class java.lang.Object

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

Field Detail

KEY_ROOM

public static final java.lang.String KEY_ROOM

*Private*

See Also:

Constant Field Values

KEY_NAME

public static java.lang.String KEY_NAME

*Private*

Constructor Detail

ChangeRoomNameRequest

public ChangeRoomNameRequest(Room room,
                             java.lang.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(sfs2x.client.requests.IRequest)

Method Detail

validate

public void validate(SmartFox sfs)
              throws sfs2x.client.exceptions.SFSValidationException

*Private*

Throws:

sfs2x.client.exceptions.SFSValidationException

execute

public void execute(SmartFox sfs)

*Private*