@kadanza/extension-sdk
    Preparing search index...

    Interface IExtensionSDKHost

    Parent-frame counterpart to IExtensionSDK.

    Listens for child messages and replies with the shared wire protocol. Create one instance per iframe.

    interface IExtensionSDKHost {
        destroy(): void;
        emitLoadPageSettings(settings: PageSettings | null): void;
        getRoutingType(): RoutingType;
        requestNavigationChange(
            payload: RequestNavigationChangePayload,
            options?: RequestOptions,
        ): Promise<NavigationChangePayload>;
        start(): void;
    }

    Implemented by

    Index
    • Tears down the listener. The instance cannot be restarted after destroy.

      Returns void

    • Asks the child to open page settings UI with the given values.

      Wire: LOAD_PAGE_SETTINGS (fire-and-forget).

      Parameters

      Returns void

    • Attaches the child message listener. Safe to call once; no-ops if already started or destroyed.

      Returns void