Interface PluginRuntimeContext

A host-provided context whose lifetime is independent of UI mounts.

interface PluginRuntimeContext {
    identity: PluginRuntimeIdentity;
    scope: PluginScope;
    getRoomScope(): PluginRoomScope;
    onRoomChanged(
        listener: (scope: PluginRoomScope | null) => void,
    ): () => void;
}

Index

Properties

Methods

getRoomScope onRoomChanged

Properties

`Readonly`identity

identity: PluginRuntimeIdentity

`Readonly`scope

scope: PluginScope

Methods

getRoomScope

getRoomScope(): PluginRoomScope
Throw NOT_READY without a room, or ABORTED after instance disposal.

Returns PluginRoomScope
- Defined in packages/core/subpaths/lifecycle/context.ts:30

onRoomChanged

onRoomChanged(listener: (scope: PluginRoomScope | null) => void): () => void
Subscribe to room changes, immediately receiving the current snapshot.
Parameters
- listener: (scope: PluginRoomScope | null) => void
Returns () => void
- Defined in packages/core/subpaths/lifecycle/context.ts:32