Class PluginCore

constructor

• new PluginCore(plugin): PluginCore

• Parameters

  • plugin: IExternalPlugin<IServerSettingsBase, IProjectSettingsBase, IPluginFieldHandler<IPluginFieldValueBase>, IPluginFieldValueBase, IDashboardParametersBase>

  Returns PluginCore

Plugin

enabledInContext

isDefault

createControl

• createControl(ctrlObj, settings): Promise<void>

• Parameters

  • ctrlObj: JQuery

  • settings: IBaseControlOptions

  Returns Promise<void>

enableControl

• enableControl(fieldType): boolean

• can be overwritten by plugin to enable or disable functionality based on what is selected/configured

  Parameters

  • fieldType: string

  Returns boolean

enableDashboardAsync

• enableDashboardAsync(): Promise<boolean>

• can be overwritten by plugin to enable or disable functionality based on what is selected/configured

  Returns Promise<boolean>

enableProjectSetting

• enableProjectSetting(): boolean

• can be overwritten by plugin to enable or disable functionality based on what is selected/configured

  Returns boolean

enableServerSetting

• enableServerSetting(): boolean

• can be overwritten by plugin to enable or disable functionality based on what is selected/configured

  Returns boolean

enableToolMenu

• enableToolMenu(ul, _hook): unknown

• can be overwritten by plugin to enable or disable functionality based on what is selected/configured

  Parameters

  • ul: JQuery

  • _hook: number

  Returns unknown

getConfig

• getConfig(): IPluginConfig<IServerSettingsBase, IProjectSettingsBase>

• Returns IPluginConfig<IServerSettingsBase, IProjectSettingsBase>

getConfigUserMenuItems

• getConfigUserMenuItems(): IPluginMenuAction[]

• Returns a list of menu items to be added to the user profile menu of the config page.

  Returns IPluginMenuAction[]

getCustomSearches

• getCustomSearches(): IPluginSearch[]

• Returns a list of custom searches to be added to the search drowpdown.

  Returns IPluginSearch[]

getCustomerSettingPagesAsync

• getCustomerSettingPagesAsync(): Promise<ISettingPage[]>

• Returns Promise<ISettingPage[]>

getDashboardLinksForAnalyticsAsync

• getDashboardLinksForAnalyticsAsync(): Promise<IDashboardParametersBase[]>

• Returns Promise<IDashboardParametersBase[]>

getFieldConfigOptions

• getFieldConfigOptions(): IFieldDescription[]

• Returns IFieldDescription[]

getPluginName

• getPluginName(): string

• Returns string

getPluginVersion

• getPluginVersion(): string

• Returns string

getProjectMenuItems

• getProjectMenuItems(): IPluginMenuAction[]

• Returns a list of menu items to be added to the project list.

  Returns IPluginMenuAction[]

getProjectPagesAsync

• getProjectPagesAsync(): Promise<IProjectPageParam[]>

• Returns Promise<IProjectPageParam[]>

getProjectSettingPagesAsync

• getProjectSettingPagesAsync(): Promise<ISettingPage[]>

• Returns Promise<ISettingPage[]>

getTiles

• getTiles(): ITile[]

• Notify the plugin to render itself in the element passed.

  Returns ITile[]

getTinyMenuItems

• getTinyMenuItems(editor): ITinyMenu[]

• Returns a list of TinyMCE menu items to be added to the editor.

  Parameters

  • editor: unknown

  Returns ITinyMenu[]

getUserMenuItems

• getUserMenuItems(): IPluginMenuAction[]

• Returns a list of menu items to be added to the user profile menu in the main app.

  Returns IPluginMenuAction[]

initItem

• initItem(_item, _jui): void

• Parameters

  • _item: IItem

  • _jui: JQuery

  Returns void

initPrintingAsync

• initPrintingAsync(): Promise<void>

• Returns Promise<void>

initProject

• initProject(project): void

• Parameters

  • project: string

  Returns void

onInitItem

• onInitItem(_item): void

• Parameters

  • _item: IItem

  Returns void

onInitProject

• onInitProject(project): void

• Parameters

  • project: string

  Returns void

supportsControl

• supportsControl(fieldType): boolean

• Returns true if the plugin offers a control that can display fields of type {fieldType}.

  Parameters

  • fieldType: string

  Returns boolean

updateMenu

• updateMenu(ul, hook): Promise<void>

• Parameters

  • ul: JQuery

  • hook: number

  Returns Promise<void>

Static getServerSetting

• getServerSetting(settingId, defaultValue): IServerSettingsBase

• Parameters

  • settingId: string

  • defaultValue: unknown

  Returns IServerSettingsBase