Class AcrolinxPlugin

Index

Constructors

Methods

check configure dispose init registerAdapter showMessage

Constructors

constructor

new AcrolinxPlugin(conf: AcrolinxPluginConfig): AcrolinxPlugin
Parameters
- conf: AcrolinxPluginConfig
Returns AcrolinxPlugin
- Defined in acrolinx-plugin.ts:331

Methods

check

check(): void
Returns void
- Defined in acrolinx-plugin.ts:352

configure

configure(conf: SidebarConfiguration): void
Parameters
- conf: SidebarConfiguration
Returns void
- Defined in acrolinx-plugin.ts:344

dispose

dispose(callback: () => void): void
Parameters
- callback: () => void
Returns void
- Defined in acrolinx-plugin.ts:381

init

init(): void
Returns void
- Defined in acrolinx-plugin.ts:372

registerAdapter

registerAdapter(adapter: AdapterInterface): void
Parameters
- adapter: AdapterInterface
Returns void
- Defined in acrolinx-plugin.ts:336

showMessage

showMessage(message: Message): void
Show a message in the Sidebar. Supported since Acrolinx Platform 2021.2 (Sidebar version 14.28).
Parameters
- message: Message
  The message to show.
Returns void
- Defined in acrolinx-plugin.ts:363