Interface: OmniscribePlugin

Defined in: types/plugin.ts:16

Base interface for all Omniscribe plugins.

Every plugin -- whether provider, frontend, or both -- implements this interface. It defines the common lifecycle (activate/deactivate) and identity properties.

Extended by

• AiProviderPlugin
• FrontendPlugin

Properties

displayName

readonly displayName: string

Defined in: types/plugin.ts:24

Human-readable display name

---

id

readonly id: string

Defined in: types/plugin.ts:18

Unique plugin identifier matching the manifest id field

---

type

readonly type: PluginType

Defined in: types/plugin.ts:21

Plugin type matching the manifest type field

Methods

activate()

activate(context): Promise<void>

Defined in: types/plugin.ts:31

Called when the plugin is activated. Use the context to register contributions, subscribe to events, and initialize state. All disposables should be added to context.subscriptions for automatic cleanup.

Parameters

Parameter	Type
context	PluginContext

Returns

Promise<void>

---

deactivate()

deactivate(): Promise<void>

Defined in: types/plugin.ts:37

Called when the plugin is deactivated. Clean up any resources not tracked via context.subscriptions.

Returns

Promise<void>