Saltar al contenido principal

Interface: KernelPluginApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:425

The API object handed to a rev4 kernel frontend plugin's activate(). Extends the v2 surface (ui, i18n, slash, interceptors, events, notify) with the kernel namespaces (rev4 §A3).

Properties

actions

readonly actions: KernelActionsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:445


auth

readonly auth: KernelAuthApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:431


backend

readonly backend: KernelBackendApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:437


blocks

readonly blocks: KernelBlocksApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:439


capabilities

readonly capabilities: KernelCapabilitiesApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:430


chats

readonly chats: KernelChatsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:438


commands

readonly commands: KernelCommandsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:433


diagnostics

readonly diagnostics: KernelDiagnosticsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:429


events

readonly events: object

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:446

onKernelRevoked()

onKernelRevoked(listener): Unregister

Parameters
listener

(grant) => void

Returns

Unregister

subscribe()

subscribe(event, listener): Promise<Unregister>

Subscribe to a whitelisted app event over the kernel port (rev4 §E1). Returns a promise resolving to an unsubscribe function; the host relay is removed automatically on disable/frame reset.

Parameters
event

string

listener

(payload) => void

Returns

Promise<Unregister>

unsubscribe()

unsubscribe(event, listener): Promise<void>

Explicit unsubscribe; idempotent for unknown pairs.

Parameters
event

string

listener

(payload) => void

Returns

Promise<void>


jobs

readonly jobs: KernelJobsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:441


limits

readonly limits: () => PluginLimits

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:428

Returns

PluginLimits


network

readonly network: KernelNetworkApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:444


notifications

readonly notifications: KernelNotificationsApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:435


overlays

readonly overlays: KernelOverlaysApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:440


pluginId

readonly pluginId: string

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:426


runtime

readonly runtime: KernelRuntimeApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:427


services

readonly services: KernelServicesApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:432


storage

readonly storage: KernelStorageApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:436


surfaces

readonly surfaces: KernelSurfacesApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:434


workers

readonly workers: KernelWorkersApi

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:443

Isolated compute workers (rev4 §C2, capability compute.worker).

Methods

notify()

notify(notification): Unregister

Defined in: packages/plugin-sdk/src/kernel/authoring.ts:458

Show a notification; returns a function to dismiss it early.

Parameters

notification

NotificationDef

Returns

Unregister