Interface IPlugin

interface IPlugin {
    addFieldSettings?: ((configApp, project, pageId, fieldType, fieldParams, ui, paramChanged, canBePublished?) => void);
    categorySetting?: ((key) => string);
    createControl?: ((ctrlObj, settings) => void);
    editCategorySetting?: ((key, category) => void);
    filterProject?: ((db) => void);
    getCustomerSettingPagesAsync?: (() => Promise<ISettingPage[]>);
    getFieldConfigOptions?: (() => IFieldDescription[]);
    getPluginName?: (() => string);
    getPluginVersion?: (() => string);
    getProjectPagesAsync?: (() => Promise<IProjectPageParam[]>);
    getProjectSettingPagesAsync?: (() => Promise<ISettingPage[]>);
    helpUrl?: string;
    initItem?: ((item, jui) => void);
    initPrintingAsync?: (() => Promise<void>);
    initProject?: ((project) => void);
    initServerSettings?: ((serverSettings) => void);
    isDefault?: boolean;
    preSaveHookAsync?: ((isItem, type, controls) => Promise<{}>);
    renderActionButtons?: ((options, body, controls) => boolean);
    supportsControl?: ((fieldType) => boolean);
    updateItem?: ((item) => void);
    updateItemPanel?: (() => void);
    updateMenu?: ((ul, hook) => void);
    updateSearchPanel?: (() => void);
    updateTree?: (() => void);
    getConfigUserMenuItems?(): IPluginMenuAction[];
    getCustomSearches?(): IPluginSearch[];
    getProjectMenuItems?(): IPluginMenuAction[];
    getQMSUserMenuItems?(): IPluginMenuAction[];
    getTinyMenuItems?(editor): ITinyMenu[];
    getUserMenuItems?(): IPluginMenuAction[];
}

Implemented by

Properties

addFieldSettings? categorySetting? createControl? editCategorySetting? filterProject? getCustomerSettingPagesAsync? getFieldConfigOptions? getPluginName? getPluginVersion? getProjectPagesAsync? getProjectSettingPagesAsync? helpUrl? initItem? initPrintingAsync? initProject? initServerSettings? isDefault? preSaveHookAsync? renderActionButtons? supportsControl? updateItem? updateItemPanel? updateMenu? updateSearchPanel? updateTree?

Methods

getConfigUserMenuItems? getCustomSearches? getProjectMenuItems? getQMSUserMenuItems? getTinyMenuItems? getUserMenuItems?

Properties

Optional addFieldSettings

addFieldSettings?: ((configApp, project, pageId, fieldType, fieldParams, ui, paramChanged, canBePublished?) => void)

Type declaration

    • (configApp, project, pageId, fieldType, fieldParams, ui, paramChanged, canBePublished?): void

    • Parameters

      • configApp: any
      • project: string
      • pageId: string
      • fieldType: string
      • fieldParams: IFieldParameter
      • ui: JQuery
      • paramChanged: (() => void)
          • (): void

          • Returns void

      • Optional canBePublished: boolean

      Returns void

Optional categorySetting

categorySetting?: ((key) => string)

Type declaration

    • (key): string

    • Parameters

      • key: string

      Returns string

Optional createControl

createControl?: ((ctrlObj, settings) => void)

Type declaration

Optional editCategorySetting

editCategorySetting?: ((key, category) => void)

Type declaration

    • (key, category): void

    • Parameters

      • key: string
      • category: string

      Returns void

Optional filterProject

filterProject?: ((db) => void)

Type declaration

    • (db): void

    • Parameters

      Returns void

Optional getCustomerSettingPagesAsync

getCustomerSettingPagesAsync?: (() => Promise<ISettingPage[]>)

Type declaration

    • (): Promise<ISettingPage[]>

    • Returns Promise<ISettingPage[]>

Optional getFieldConfigOptions

getFieldConfigOptions?: (() => IFieldDescription[])

Type declaration

    • (): IFieldDescription[]

    • Returns IFieldDescription[]

Optional getPluginName

getPluginName?: (() => string)

Type declaration

    • (): string

    • Returns string

Optional getPluginVersion

getPluginVersion?: (() => string)

Type declaration

    • (): string

    • Returns string

Optional getProjectPagesAsync

getProjectPagesAsync?: (() => Promise<IProjectPageParam[]>)

Type declaration

Optional getProjectSettingPagesAsync

getProjectSettingPagesAsync?: (() => Promise<ISettingPage[]>)

Type declaration

    • (): Promise<ISettingPage[]>

    • Returns Promise<ISettingPage[]>

Optional helpUrl

helpUrl?: string

Optional initItem

initItem?: ((item, jui) => void)

Type declaration

    • (item, jui): void

    • Parameters

      Returns void

Optional initPrintingAsync

initPrintingAsync?: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

Optional initProject

initProject?: ((project) => void)

Type declaration

    • (project): void

    • Parameters

      • project: string

      Returns void

Optional initServerSettings

initServerSettings?: ((serverSettings) => void)

Type declaration

    • (serverSettings): void

    • Parameters

      • serverSettings: XRListProjectAndSettings

      Returns void

Optional isDefault

isDefault?: boolean

Optional preSaveHookAsync

preSaveHookAsync?: ((isItem, type, controls) => Promise<{}>)

Type declaration

    • (isItem, type, controls): Promise<{}>

    • Parameters

      • isItem: boolean
      • type: string
      • controls: IControlDefinition[]

      Returns Promise<{}>

Optional renderActionButtons

renderActionButtons?: ((options, body, controls) => boolean)

Type declaration

    • (options, body, controls): boolean

    • Parameters

      • options: IItemControlOptions
      • body: JQuery
      • controls: IControlDefinition[]

      Returns boolean

Optional supportsControl

supportsControl?: ((fieldType) => boolean)

Type declaration

    • (fieldType): boolean

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

      Parameters

      • fieldType: string

      Returns boolean

Optional updateItem

updateItem?: ((item) => void)

Type declaration

    • (item): void

    • Parameters

      Returns void

Optional updateItemPanel

updateItemPanel?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional updateMenu

updateMenu?: ((ul, hook) => void)

Type declaration

    • (ul, hook): void

    • Parameters

      • ul: JQuery
      • hook: number

      Returns void

Optional updateSearchPanel

updateSearchPanel?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional updateTree

updateTree?: (() => void)

Type declaration

    • (): void

    • Returns void

Methods

Optional getConfigUserMenuItems

  • getConfigUserMenuItems(): IPluginMenuAction[]

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

    Returns IPluginMenuAction[]

Optional getCustomSearches

  • getCustomSearches(): IPluginSearch[]

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

    Returns IPluginSearch[]

Optional getProjectMenuItems

  • getProjectMenuItems(): IPluginMenuAction[]

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

    Returns IPluginMenuAction[]

Optional getQMSUserMenuItems

  • getQMSUserMenuItems(): IPluginMenuAction[]

  • Returns a list of menu items to be added to the QMS user profile menu in the liveqms.

    Returns IPluginMenuAction[]

Optional getTinyMenuItems

  • getTinyMenuItems(editor): ITinyMenu[]

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

    Parameters

    • editor: any

    Returns ITinyMenu[]

Optional getUserMenuItems

  • getUserMenuItems(): IPluginMenuAction[]

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

    Returns IPluginMenuAction[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc