PluginUtil
An instance of this class represents Plugin utility service
Static Method Summary
| Static Public Methods | ||
| public static |
createService(chrisClient: Client): PluginUtil Create a service object of this class |
|
Constructor Summary
| Public Constructor | ||
| public |
constructor(chrisClient: Client) Constructor |
|
Member Summary
| Public Members | ||
| public |
chrisClient: * |
|
Method Summary
| Public Methods | ||
| public |
async getPluginId(pluginName: String): Promise<number> Get a plugin id from its given name |
|
| public |
async getPluginInstance(instId: number): Promise<PluginInstance> Get a plugin instance running in CUBE from its id |
|
| public |
async pollPlugin(pluginInst: *, callback: *, callbackParams: *): * |
|
| public |
Run a plugin in CUBE, given its id and params |
|
Static Public Methods
public static createService(chrisClient: Client): PluginUtil source
Create a service object of this class
Params:
| Name | Type | Attribute | Description |
| chrisClient | Client | A ChRIS client object |
Public Constructors
public constructor(chrisClient: Client) source
Constructor
Params:
| Name | Type | Attribute | Description |
| chrisClient | Client | A Chris Client Object |
Public Members
public chrisClient: * source
Public Methods
public async getPluginId(pluginName: String): Promise<number> source
Get a plugin id from its given name
Params:
| Name | Type | Attribute | Description |
| pluginName | String | A name of a chris plugin registered to CUBE |
public async getPluginInstance(instId: number): Promise<PluginInstance> source
Get a plugin instance running in CUBE from its id
Params:
| Name | Type | Attribute | Description |
| instId | number | A plugin isntance id |
public async pollPlugin(pluginInst: *, callback: *, callbackParams: *): * source
Params:
| Name | Type | Attribute | Description |
| pluginInst | * | ||
| callback | * | ||
| callbackParams | * |
Return:
| * |