im2-link-jssdk - v1.4.3
    Preparing search index...

    Interface IMWebHostOptions

    interface IMWebHostOptions {
        additionalMessageTypes?: readonly string[];
        messageWindow?: Pick<Window, "addEventListener" | "removeEventListener">;
        getTarget(): IMWebTarget | null;
        normalizeMessage?(value: unknown): unknown;
        onError?(error: unknown): void;
        onMessage(request: IMWebRequest): void | Promise<void>;
    }
    Index

    Properties

    additionalMessageTypes? messageWindow?

    Methods

    getTarget normalizeMessage? onError? onMessage

    Properties

    additionalMessageTypes?: readonly string[]

    默认只接受 SDK 枚举；宿主可显式增加旧游戏事件，例如 ShareRoom。

    messageWindow?: Pick<Window, "addEventListener" | "removeEventListener">

    默认是当前 window；测试或多窗口宿主可显式指定监听窗口。

    Methods

    • 每次接收/回复都读取当前 iframe 身份。

      Returns IMWebTarget | null

    • 校验窗口来源后、解析前转换宿主已有的扩展消息包装；不用于放宽来源校验。

      Parameters

      • value: unknown

      Returns unknown

    • 业务错误上报入口；SDK 不打印消息中的 app token 或业务参数。

      Parameters

      • error: unknown

      Returns void

    • 处理消息并通过 request.reply 回结果；Promise 拒绝会回 HOST_ERROR。

      Parameters

      Returns void | Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods