sfs2x.client.requests
Class RoomPermissions

java.lang.Object
  sfs2x.client.requests.RoomPermissions

public class RoomPermissions
extends java.lang.Object

The RoomPermissions class contains a specific subset of the RoomSettings required to create a Room. It defines which operations users will be able to execute on the Room after its creation.

See Also:

RoomSettings.getPermissions(), CreateRoomRequest

Constructor Summary

RoomPermissions()
Creates a new RoomPermissions instance.

Method Summary

boolean	getAllowNameChange() Indicates whether changing the Room name after its creation is allowed or not.
boolean	getAllowPasswordStateChange() Indicates whether changing (or removing) the Room password after its creation is allowed or not.
boolean	getAllowPublicMessages() Indicates whether users inside the Room are allowed to send public messages or not.
boolean	getAllowResizing() Indicates whether the Room capacity can be changed after its creation or not.
void	setAllowNameChange(boolean allowNameChange) *Private*
void	setAllowPasswordStateChange(boolean allowPasswordStateChange) *Private*
void	setAllowPublicMessages(boolean allowPublicMessages) *Private*
void	setAllowResizing(boolean allowResizing) *Private*

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomPermissions

public RoomPermissions()

Creates a new RoomPermissions instance. The RoomSettings.permissions property must be set to this instance during Room creation.

See Also:

RoomSettings.permissions

Method Detail

getAllowNameChange

public boolean getAllowNameChange()

Indicates whether changing the Room name after its creation is allowed or not.

The Room name can be changed by means of the ChangeRoomNameRequest request.

Default: false

See Also:

ChangeRoomNameRequest

setAllowNameChange

public void setAllowNameChange(boolean allowNameChange)

*Private*

getAllowPasswordStateChange

public boolean getAllowPasswordStateChange()

Indicates whether changing (or removing) the Room password after its creation is allowed or not.

The Room password can be changed by means of the ChangeRoomPasswordStateRequest request.

Default: false

See Also:

ChangeRoomPasswordStateRequest

setAllowPasswordStateChange

public void setAllowPasswordStateChange(boolean allowPasswordStateChange)

*Private*

getAllowPublicMessages

public boolean getAllowPublicMessages()

Indicates whether users inside the Room are allowed to send public messages or not.

Public messages can be sent by means of the PublicMessageRequest request.

Default: false

See Also:

PublicMessageRequest

setAllowPublicMessages

public void setAllowPublicMessages(boolean allowPublicMessages)

*Private*

getAllowResizing

public boolean getAllowResizing()

Indicates whether the Room capacity can be changed after its creation or not.

The capacity is the maximum number of users and spectators (in Game Rooms) allowed to enter the Room. It can be changed by means of the ChangeRoomCapacityRequest request.

Default: false

See Also:

ChangeRoomCapacityRequest

setAllowResizing

public void setAllowResizing(boolean allowResizing)

*Private*