Packagecom.electrotank.electroserver4.plugin
Classpublic class Plugin

This class is used to represent a plugin that is to be created and associated with a room. See the CreateRoomRequest class for a thorough create room example that includes creating a plugin.


Public Methods
 MethodDefined by
  
Plugin()
Plugin
  
getData():EsObject
Gets an EsObject that will be passed into the plugin's init event.
Plugin
  
getExtensionName():String
Gets the extension name.
Plugin
  
getPluginHandle():String
Gets the plugin handle.
Plugin
  
getPluginName():String
The name of the plugin that is being created.
Plugin
  
setExtensionName(extensionName:String):void
The name of the extension that holds the plugin to be created.
Plugin
  
setPluginHandle(pluginHandle:String):void
The name the plugin goes by in the extension.
Plugin
  
setPluginName(pluginName:String):void
The name to give the plugin that is being created.
Plugin
Constructor detail
Plugin()constructor
public function Plugin()
Method detail
getData()method
public function getData():EsObject

Gets an EsObject that will be passed into the plugin's init event.

Returns
EsObject
getExtensionName()method 
public function getExtensionName():String

Gets the extension name.

Returns
String — The extension name.
getPluginHandle()method 
public function getPluginHandle():String

Gets the plugin handle.

Returns
String — The plugin handle.
getPluginName()method 
public function getPluginName():String

The name of the plugin that is being created.

Returns
String — The name you are giving to a plugin that is being created.
setExtensionName()method 
public function setExtensionName(extensionName:String):void

The name of the extension that holds the plugin to be created.

Parameters
extensionName:String — The name of the extension.
setPluginHandle()method 
public function setPluginHandle(pluginHandle:String):void

The name the plugin goes by in the extension.

Parameters
pluginHandle:String — The name the plugin goes by in the extension.
setPluginName()method 
public function setPluginName(pluginName:String):void

The name to give the plugin that is being created. So it is like an instance name. setPluginHandle is where you specify the name by which the plugin is stored in the extension.

Parameters
pluginName:String — The name of the plugin.