Package sfs2x.client.requests
Class RoomExtension
- java.lang.Object
-
- sfs2x.client.requests.RoomExtension
-
public class RoomExtension extends java.lang.Object
The RoomExtension class contains a specific subset of the RoomSettings required to create a Room. It defines which server-side Extension should be attached to the Room upon creation.The client can communicate with the Room Extension by means of the ExtensionRequest request.
-
-
Constructor Summary
Constructors Constructor Description RoomExtension(java.lang.String id, java.lang.String className)
Creates a new RoomExtension instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getClassName()
Returns the fully qualified name of the main class of the Extension.java.lang.String
getId()
Returns the name of the Extension to be attached to the Room.java.lang.String
getPropertiesFile()
Defines the name of an optional properties file that should be loaded on the server-side during the Extension initialization.void
setPropertiesFile(java.lang.String fileName)
-
-
-
Constructor Detail
-
RoomExtension
public RoomExtension(java.lang.String id, java.lang.String className)
Creates a new RoomExtension instance. The RoomSettings.extension property must be set to this instance during Room creation.- Parameters:
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.className
- The fully qualified name of the main class of the Extension.- See Also:
RoomSettings.getExtension()
-
-
Method Detail
-
getId
public java.lang.String getId()
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.- See Also:
RoomExtension(String, String)
-
getClassName
public java.lang.String getClassName()
Returns the fully qualified name of the main class of the Extension.- See Also:
RoomExtension(String, String)
-
getPropertiesFile
public java.lang.String getPropertiesFile()
Defines 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).- See Also:
getId()
-
setPropertiesFile
public void setPropertiesFile(java.lang.String fileName)
- See Also:
getPropertiesFile()
-
-