Packagecom.smartfoxserver.v2.requests
Classpublic class RoomPermissions
InheritanceRoomPermissions Inheritance 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.permissions
CreateRoomRequest


Public Properties
 PropertyDefined By
  allowNameChange : Boolean
Indicates whether changing the Room name after its creation is allowed or not.
RoomPermissions
  allowPasswordStateChange : Boolean
Indicates whether changing (or removing) the Room password after its creation is allowed or not.
RoomPermissions
  allowPublicMessages : Boolean
Indicates whether users inside the Room are allowed to send public messages or not.
RoomPermissions
  allowResizing : Boolean
Indicates whether the Room capacity can be changed after its creation or not.
RoomPermissions
Public Methods
 MethodDefined By
  
Creates a new RoomPermissions instance.
RoomPermissions
Property Detail
allowNameChangeproperty
allowNameChange:Boolean

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.


Implementation
    public function get allowNameChange():Boolean
    public function set allowNameChange(value:Boolean):void

See also

allowPasswordStateChangeproperty 
allowPasswordStateChange:Boolean

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.


Implementation
    public function get allowPasswordStateChange():Boolean
    public function set allowPasswordStateChange(value:Boolean):void

See also

allowPublicMessagesproperty 
allowPublicMessages:Boolean

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.


Implementation
    public function get allowPublicMessages():Boolean
    public function set allowPublicMessages(value:Boolean):void

See also

allowResizingproperty 
allowResizing:Boolean

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.


Implementation
    public function get allowResizing():Boolean
    public function set allowResizing(value:Boolean):void

See also

Constructor Detail
RoomPermissions()Constructor
public function RoomPermissions()

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

See also