RoomExtension

Stores a subset of the settings required to create a Room, relative to the server-side Extension to attach to the Room (if any).

Constructor

new RoomExtension(id, className)

Creates a new instance of the RoomExtension class.
The RoomSettings#extension property must be set to this instance during Room creation.
Parameters:
NameTypeDescription
idstringThe identifier of the Extension deployed on the server: it's the name of the folder containing the Extension classes inside the server's /extensions folder.
classNamestringThe fully-qualified name of the main class of the Extension.

Members

className :string

Fully-qualified name of the main class of the Extension.
Type:
  • string

id :string

Identifier (name) of the Extension to be attached to the Room.

This is the name of the folder containing the Extension classes inside the server's /extensions folder.

Type:
  • string

propertiesFile :string

Name of an optional properties file that should be loaded on the server side during the Extension initialization.

The properties file must be located in the same folder containing the Extension classes on the server side.

Type:
  • string
Default Value
  • (empty string)