Class SFS2X.Requests.RoomExtension

A subset of the RoomSettings defining which server-side Extension should be attached to the Room upon creation.

Class Summary
Constructor Attributes	Constructor Name and Description
	SFS2X.Requests.RoomExtension(id, className) Creates a new RoomExtension instance.

Field Summary

Field Attributes	Field Name and Description
	className Returns the fully qualified name of the main class of the Extension.
	id Returns the name of the Extension to be attached to the Room.
	propertiesFile Sets the name of an optional properties file that should be loaded on the server-side during the Extension initialization.

Class Detail

SFS2X.Requests.RoomExtension(id, className)

Creates a new RoomExtension instance.

The RoomSettings.extension property must be set to this instance during Room creation.

Parameters:
{String} id: The name of the Extension as deployed on the server; it's the name of the folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder.
{String} className: The fully qualified name of the main class of the Extension.

See also:: SFS2X.Requests.RoomSettings#extension; SFS2X.Requests.System.CreateRoomRequest; SFS2X.Requests.System.ExtensionRequest

Field Detail

{String} className

Returns the fully qualified name of the main class of the Extension.

{String} id

Returns the name of the Extension to be attached to the Room. It's the name of the server-side folder containing the Extension classes inside the main [sfs2x-install-folder]/SFS2X/extensions folder.

{String} propertiesFile

Sets the name of an optional properties file that should be loaded on the server-side during the Extension initialization. The file must be located in the server-side folder containing the Extension classes (see the id property).

Default Value:: An empty string

Classes

Field Summary

Class Detail

Field Detail