Package sfs3.client.requests

Class RoomExtension

java.lang.Object
sfs3.client.requests.RoomExtension
public class RoomExtension extends 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.

See Also:

  • Constructor Details

    • RoomExtension

      public RoomExtension(String id, 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 server/extensions/ folder.
      className - The fully qualified name of the main class of the Extension.
      See Also:

  • Method Details

    • getId

      public 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 server/extensions folder.
      See Also:

    • getClassName

      public String getClassName()
      Returns the fully qualified name of the main class of the Extension.
      See Also:

    • getPropertiesFile

      public 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:

    • setPropertiesFile

      public void setPropertiesFile(String fileName)
      See Also: