Package sfs3.client.requests

Class RoomPermissions

java.lang.Object
sfs3.client.requests.RoomPermissions
public class RoomPermissions extends 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:

  • Constructor Details

    • RoomPermissions

      public RoomPermissions()
      Creates a new RoomPermissions instance. The RoomSettings.permissions property must be set to this instance during Room creation.
      See Also:

  • Method Details

    • 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.

      The default value is false

      See Also:

    • setAllowNameChange

      public RoomPermissions setAllowNameChange(boolean allowNameChange)
      See Also:

    • 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.

      The default value is false

      See Also:

    • setAllowPasswordStateChange

      public RoomPermissions setAllowPasswordStateChange(boolean allowPasswordStateChange)
      See Also:

    • 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.

      The default value is false

      See Also:

    • setAllowPublicMessages

      public RoomPermissions setAllowPublicMessages(boolean allowPublicMessages)
      See Also:

    • 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.

      The default value is false

      See Also:

    • setAllowResizing

      public RoomPermissions setAllowResizing(boolean allowResizing)
      See Also: