Interface IExternalPlugin<SERVERSETTINGS, PROJECTSETTINGS, FIELDHANDLER, FIELDVALUETYPE, DASHBOARDPARAMS>

This is the interface that plugin that use our boilerplate template must implement. It is used to define the plugin capabilities and to configure the plugin. The plugin is instantiated once.

interface IExternalPlugin {
    PLUGIN_NAME: string;
    PLUGIN_VERSION: string;
    enableToolMenu(ul, _hook): unknown;
    getConfig(): IPluginConfig<SERVERSETTINGS, PROJECTSETTINGS>;
    getConfigUserMenuItems?(): IPluginMenuAction[];
    getControlAsync(ctrlObj): Promise<ControlCoreBase<FIELDHANDLER, FIELDVALUETYPE>>;
    getCustomSearches?(): IPluginSearch[];
    getDashboardAsync(): Promise<IDashboardPage<DASHBOARDPARAMS>>;
    getProjectMenuItems?(): IPluginMenuAction[];
    getProjectSettingsPageAsync(): Promise<IPluginSettingPage<PROJECTSETTINGS>>;
    getQMSUserMenuItems?(): IPluginMenuAction[];
    getServerSettingsPageAsync(): Promise<IPluginSettingPage<SERVERSETTINGS>>;
    getTinyMenuItems?(editor): ITinyMenu[];
    getToolAsync(): Promise<ITool>;
    getUserMenuItems?(): IPluginMenuAction[];
    onInitItem(_item): unknown;
    onInitProject(project): unknown;
}

Type Parameters

SERVERSETTINGS extends IServerSettingsBase
The type of the server settings
PROJECTSETTINGS extends IProjectSettingsBase
The type of the project settings
FIELDHANDLER extends IPluginFieldHandler<FIELDVALUETYPE>
The fieldhandle that will be responsible for the field data validation
FIELDVALUETYPE extends IPluginFieldValueBase
The type of the field value. This is the type of the data that will be stored in the database
DASHBOARDPARAMS extends IDashboardParametersBase
The type of the dashboard parameters that will be used to render the dashboard.

Hierarchy

IPluginCoreForDashboard<DASHBOARDPARAMS>
- IExternalPlugin

Index

Properties

PLUGIN_NAME PLUGIN_VERSION

Methods

enableToolMenu getConfig getConfigUserMenuItems? getControlAsync getCustomSearches? getDashboardAsync getProjectMenuItems? getProjectSettingsPageAsync getQMSUserMenuItems? getServerSettingsPageAsync getTinyMenuItems? getToolAsync getUserMenuItems? onInitItem onInitProject

Properties

PLUGIN_NAME

PLUGIN_NAME: string

PLUGIN_VERSION

PLUGIN_VERSION: string

Methods

enableToolMenu

enableToolMenu(ul, _hook): unknown
Parameters
- ul: JQuery
- _hook: number
Returns unknown
- Defined in ts/sdk/plugins/interfaces.ts:143

getConfig

getConfig(): IPluginConfig<SERVERSETTINGS, PROJECTSETTINGS>
return the plugin configuration.

Returns IPluginConfig<SERVERSETTINGS, PROJECTSETTINGS>
Overrides IPluginCoreForDashboard.getConfig
- Defined in ts/sdk/plugins/interfaces.ts:212

`Optional` getConfigUserMenuItems

getConfigUserMenuItems(): IPluginMenuAction[]
Returns a list of menu items to be added to the user profile menu of the config page.

Returns IPluginMenuAction[]
- Defined in ts/sdk/plugins/interfaces.ts:192

getControlAsync

getControlAsync(ctrlObj): Promise<ControlCoreBase<FIELDHANDLER, FIELDVALUETYPE>>
Returns a control object for a given field type. This is used to render the field in the main app.
Parameters
- ctrlObj: JQuery
Returns Promise<ControlCoreBase<FIELDHANDLER, FIELDVALUETYPE>>
- Defined in ts/sdk/plugins/interfaces.ts:171

`Optional` getCustomSearches

getCustomSearches(): IPluginSearch[]
Returns a list of custom searches to be added to the search drowpdown.

Returns IPluginSearch[]
- Defined in ts/sdk/plugins/interfaces.ts:202

getDashboardAsync

getDashboardAsync(): Promise<IDashboardPage<DASHBOARDPARAMS>>
Returns a page to be added to the dashboard in the main app.

Returns Promise<IDashboardPage<DASHBOARDPARAMS>>
Overrides IPluginCoreForDashboard.getDashboardAsync
- Defined in ts/sdk/plugins/interfaces.ts:155

`Optional` getProjectMenuItems

getProjectMenuItems(): IPluginMenuAction[]
Returns a list of menu items to be added to the project list.

Returns IPluginMenuAction[]
- Defined in ts/sdk/plugins/interfaces.ts:197

getProjectSettingsPageAsync

getProjectSettingsPageAsync(): Promise<IPluginSettingPage<PROJECTSETTINGS>>
Returns a page to be added to the customer settings page in the adminConfig.

Returns Promise<IPluginSettingPage<PROJECTSETTINGS>>
- Defined in ts/sdk/plugins/interfaces.ts:160

`Optional` getQMSUserMenuItems

getQMSUserMenuItems(): IPluginMenuAction[]
Returns a list of menu items to be added to the QMS user profile menu in the liveqms.

Returns IPluginMenuAction[]
- Defined in ts/sdk/plugins/interfaces.ts:207

getServerSettingsPageAsync

getServerSettingsPageAsync(): Promise<IPluginSettingPage<SERVERSETTINGS>>
Returns a page to be added to the server settings page in the adminConfig.

Returns Promise<IPluginSettingPage<SERVERSETTINGS>>
- Defined in ts/sdk/plugins/interfaces.ts:165

`Optional` getTinyMenuItems

getTinyMenuItems(editor): ITinyMenu[]
Returns a list of TinyMCE menu items to be added to the editor.
Parameters
- editor: unknown
Returns ITinyMenu[]
- Defined in ts/sdk/plugins/interfaces.ts:182

getToolAsync

getToolAsync(): Promise<ITool>
Returns a tool to be added to the tools menu in the main app.

Returns Promise<ITool>
- Defined in ts/sdk/plugins/interfaces.ts:176

`Optional` getUserMenuItems

getUserMenuItems(): IPluginMenuAction[]
Returns a list of menu items to be added to the user profile menu in the main app.

Returns IPluginMenuAction[]
- Defined in ts/sdk/plugins/interfaces.ts:187

onInitItem

onInitItem(_item): unknown
Parameters
- _item: IItem
Returns unknown
- Defined in ts/sdk/plugins/interfaces.ts:144

onInitProject

onInitProject(project): unknown
Parameters
- project: string
Returns unknown
- Defined in ts/sdk/plugins/interfaces.ts:145

Interface IExternalPlugin<SERVERSETTINGS, PROJECTSETTINGS, FIELDHANDLER, FIELDVALUETYPE, DASHBOARDPARAMS>

Type Parameters

SERVERSETTINGS extends IServerSettingsBase

PROJECTSETTINGS extends IProjectSettingsBase

FIELDHANDLER extends IPluginFieldHandler<FIELDVALUETYPE>

FIELDVALUETYPE extends IPluginFieldValueBase

DASHBOARDPARAMS extends IDashboardParametersBase

Hierarchy

Index

Properties

Methods

Properties

PLUGIN_NAME

PLUGIN_VERSION

Methods

enableToolMenu

Parameters

ul: JQuery

_hook: number

Returns unknown

getConfig

Returns IPluginConfig<SERVERSETTINGS, PROJECTSETTINGS>

Optional getConfigUserMenuItems

Returns IPluginMenuAction[]

getControlAsync

Parameters

ctrlObj: JQuery

Returns Promise<ControlCoreBase<FIELDHANDLER, FIELDVALUETYPE>>

Optional getCustomSearches

Returns IPluginSearch[]

getDashboardAsync

Returns Promise<IDashboardPage<DASHBOARDPARAMS>>

Optional getProjectMenuItems

Returns IPluginMenuAction[]

getProjectSettingsPageAsync

Returns Promise<IPluginSettingPage<PROJECTSETTINGS>>

Optional getQMSUserMenuItems

Returns IPluginMenuAction[]

getServerSettingsPageAsync

Returns Promise<IPluginSettingPage<SERVERSETTINGS>>

Optional getTinyMenuItems

Parameters

editor: unknown

Returns ITinyMenu[]

getToolAsync

Returns Promise<ITool>

Optional getUserMenuItems

Returns IPluginMenuAction[]

onInitItem

Parameters

_item: IItem

Returns unknown

onInitProject

Parameters

project: string

Returns unknown

Settings

Member Visibility

Theme

On This Page

`Optional` getConfigUserMenuItems

`Optional` getCustomSearches

`Optional` getProjectMenuItems

`Optional` getQMSUserMenuItems

`Optional` getTinyMenuItems

`Optional` getUserMenuItems