foo-webview-sdk
    Preparing search index...

    Interface NativeFb2k

    Native bridge surface injected by the host into the WebView2 page.

    Every method shape is intentionally untyped on the value side (unknown / Record<string, unknown>); higher-level wrappers in src/bridge/Bridge.ts narrow the types using the response interfaces from "./responses" and the payload map from "./events".

    interface NativeFb2k {
        invoke<TResp = unknown>(method: string, params?: object): Promise<TResp>;
        off(event: string, handler: (data: unknown) => void): void;
        on(event: string, handler: (data: unknown) => void): () => void;
        once(event: string, handler: (data: unknown) => void): () => void;
    }
    Index
    invoke off on once

    • Invoke a registered C++ API by canonical <namespace>.<method> name.

      Type Parameters

      • TResp = unknown

      Parameters

      • method: string

        Canonical API name in dot notation (e.g. playback.play).

      • Optionalparams: object

        Optional parameter object; structure determined by the registered C++ handler.

      Returns Promise<TResp>

      Promise resolving to the handler's JSON-serialised return value, or rejecting with an ErrorEnvelope-shaped object.

    • Detach a previously registered event handler.

      Parameters

      • event: string

        Same canonical name used in NativeFb2k.on.

      • handler: (data: unknown) => void

        Reference to the same handler function instance that was originally subscribed.

      Returns void

    • Subscribe to a C++-emitted event.

      Parameters

      • event: string

        Canonical event name in colon notation (e.g. playback:stateChanged).

      • handler: (data: unknown) => void

        Handler invoked with the event payload on every dispatch.

      Returns () => void

      Unsubscribe callback. Calling the returned function detaches the handler.

    • One-shot subscription; the handler is automatically unsubscribed after the first dispatch.

      Parameters

      • event: string
      • handler: (data: unknown) => void

      Returns () => void

    Settings
    Member Visibility

    On This Page
    Methods