Sfs2X::Requests::RoomExtension Class Reference

This object is part of the RoomSettings parameters used for creating a new Room. More...

#include <RoomExtension.h>

Public Member Functions
	RoomExtension (string id, string className)
	Constructor More...
boost::shared_ptr< string >	Id ()
	The name of the extension More...
boost::shared_ptr< string >	ClassName ()
	The fully qualified name of the main class in the extension More...
boost::shared_ptr< string >	PropertiesFile ()
	An optional properties file that will be loaded on the server side when the extension is initialized More...
void	PropertiesFile (string value)
	An optional properties file that will be loaded on the server side when the extension is initialized More...

Detailed Description

This object is part of the RoomSettings parameters used for creating a new Room.

It describes the properties of an Extension attached to the Room

See also

RoomSettings, CreateRoomRequest

Constructor & Destructor Documentation

RoomExtension()

Sfs2X::Requests::RoomExtension::RoomExtension	(	string	id,
		string	className
	)

Constructor

Parameters

id	the name of the extension
className	the fully qualified name of the main class in the extension

See also

RoomSettings, CreateRoomRequest

Member Function Documentation

ClassName()

boost::shared_ptr< string > Sfs2X::Requests::RoomExtension::ClassName

(

)

The fully qualified name of the main class in the extension

Id()

boost::shared_ptr< string > Sfs2X::Requests::RoomExtension::Id

(

)

The name of the extension

PropertiesFile() [1/2]

boost::shared_ptr< string > Sfs2X::Requests::RoomExtension::PropertiesFile

(

)

An optional properties file that will be loaded on the server side when the extension is initialized

PropertiesFile() [2/2]

void Sfs2X::Requests::RoomExtension::PropertiesFile

(

string

value

)

An optional properties file that will be loaded on the server side when the extension is initialized