W3Booster SDK 2.0.0
    Preparing search index...

    Interface W3BoosterHost<TSettings>

    interface W3BoosterHost<TSettings extends object = JsonObject> {
        available: boolean;
        capabilities: readonly HostCapability[];
        capabilityStatus: HostCapabilityStatus;
        lifecycle: HostLifecycleStore;
        can(capability: HostCapability): boolean;
        closeWindow(options?: HostActionOptions): Promise<void>;
        command<TResult>(
            command: string,
            payload: JsonValue | undefined,
            options: HostCommandOptions<TResult>,
        ): Promise<TResult>;
        command(
            command: string,
            payload?: JsonValue,
            options?: HostActionOptions,
        ): Promise<unknown>;
        openWindow(
            options?: OpenWindowOptions,
            actionOptions?: HostActionOptions,
        ): Promise<void>;
        refreshCapabilities(
            options?: HostActionOptions,
        ): Promise<readonly HostCapability[]>;
        setSetting<TPath extends string>(
            path: TPath,
            value: SettingsPathValue<TSettings, TPath>,
            options?: HostActionOptions,
        ): Promise<DeepReadonly<TSettings>>;
        startAutoResize(): void;
        stopAutoResize(): void;
        subscribeCapabilities(
            listener: (
                capabilities: readonly HostCapability[],
                status: HostCapabilityStatus,
            ) => void | Promise<void>,
            options?: SubscriptionOptions,
        ): () => void;
        supports(capability: HostCapability): boolean;
    }

    Type Parameters

    Index
    available capabilities capabilityStatus lifecycle
    can closeWindow command openWindow refreshCapabilities setSetting startAutoResize stopAutoResize subscribeCapabilities supports
    available: boolean
    capabilities: readonly HostCapability[]
    capabilityStatus: HostCapabilityStatus

    Discovery state; actions require an explicit advertised capability.

    lifecycle: HostLifecycleStore

    • Whether an explicitly advertised action is currently available.

      Parameters

      Returns boolean

    • Returns void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods