RoomPermissions

Stores a subset of the settings required to create a Room, relative to the Room features enabled at runtime.

Constructor

new RoomPermissions()

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

Members

allowNameChange :boolean

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

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

Type:
  • boolean
Default Value
  • false

allowPasswordStateChange :boolean

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

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

Type:
  • boolean
Default Value
  • false

allowPublicMessages :boolean

Indicates whether Users inside the Room are allowed to send public messages.

Public messages can be sent by means of the PublicMessageRequest.

Type:
  • boolean
Default Value
  • true

allowResizing :boolean

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

The capacity is the maximum number of Users and Spectators (in Game Rooms) allowed to join the Room. It can be changed by means of the ChangeRoomCapacityRequest.

Type:
  • boolean
Default Value
  • false