| Package | com.smartfoxserver.v2.requests |
| Class | public class RoomExtension |
| Inheritance | RoomExtension  Object |
The client can communicate with the Room Extension by means of the ExtensionRequest request.
See also
| Property | Defined By | ||
|---|---|---|---|
| className : String [read-only]
Returns the fully qualified name of the main class of the Extension. | RoomExtension | ||
| id : String [read-only]
Returns the name of the Extension to be attached to the Room. | RoomExtension | ||
| propertiesFile : String
Defines the name of an optional properties file that should be loaded on the server-side during the Extension initialization. | RoomExtension | ||
| Method | Defined By | ||
|---|---|---|---|
RoomExtension(id:String, className:String)
Creates a new RoomExtension instance. | RoomExtension | ||
| className | property |
className:String [read-only] Returns the fully qualified name of the main class of the Extension.
public function get className():String| id | property |
id:String [read-only] 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.
public function get id():String| propertiesFile | property |
propertiesFile:StringDefines 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).
public function get propertiesFile():String public function set propertiesFile(value:String):voidSee also
| RoomExtension | () | Constructor |
public function RoomExtension(id:String, className:String)Creates a new RoomExtension instance. The RoomSettings.extension property must be set to this instance during Room creation.
Parametersid:String — 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.
| |
className:String — The fully qualified name of the main class of the Extension.
|
See also