Package sfs3.client.requests

Class ChangeRoomPasswordStateRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.ChangeRoomPasswordStateRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class ChangeRoomPasswordStateRequest
extends BaseRequest

Changes the password of a Room. This request not only changes the password of a Room, but also its "password state", which indicates if the Room is password protected or not.

If the operation is successful, the roomPasswordStateChange event is dispatched to all the users who subscribed the Group to which the target Room belongs, including the requester user himself. If the user is not the creator (owner) of the Room the roomPasswordStateChangeError event if fired. An administrator or moderator can override the constraint (he is not requested to be the Room's owner).

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

See Also:

• SFSEvent.ROOM_PASSWORD_STATE_CHANGE
• SFSEvent.ROOM_PASSWORD_STATE_CHANGE_ERROR
• RoomSettings.getPermissions()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_PASS
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
ChangeRoomPasswordStateRequest(Room room, String newPass)	Creates a new ChangeRoomPasswordStateRequest 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_PASS

public static final String KEY_PASS

See Also:

• Constant Field Values

Internal

Constructor Details

ChangeRoomPasswordStateRequest

public ChangeRoomPasswordStateRequest(Room room,
 String newPass)

Creates a new ChangeRoomPasswordStateRequest 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 password should be changed.

newPass - The new password to be assigned to the Room; an empty string or the null value can be passed to remove the Room's password.

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