Type Alias WxWindow

Type declaration

• frame:function

  • frame(
        iframe: IFrameLike,
        onRecv: WxEndRecvFn,
        options?: WxEndOptions,
    ): Promise<WxResult<WxEnd>>

    Create a WxEnd for messaging to an iframe

    Parameters

    • iframe: IFrameLike
    • onRecv: WxEndRecvFn
    • Optionaloptions: WxEndOptions

    Returns Promise<WxResult<WxEnd>>

• owner:function

  • owner(
        ownerOrigin: string,
        onRecv: WxEndRecvFn,
        options?: WxEndOptions,
    ): Promise<WxResult<WxEnd>>

    Create a WxEnd for messaging to the owner of the window. For window opened with window.open, this is the window that opened the window (i.e. the window.opener object). For iframes, this is the window that contains the iframe (i.e. the window.parent object).

    Note that if this window and the owner are same-origin, the browser may put them in the same context, in which case messaging is done by directly calling the handler, since they are in the same context.

    Parameters

    • ownerOrigin: string
    • onRecv: WxEndRecvFn
    • Optionaloptions: WxEndOptions

    Returns Promise<WxResult<WxEnd>>

• popup:function

  • popup(
        url: string,
        onRecv: WxEndRecvFn,
        options?: WxWindowOpenOptions,
    ): Promise<WxResult<WxEnd>>

    Open a Popup window and create a WxEnd for messaging to that window.

    The returned end is tied to the window. If either the window or the end is closed, the popup window and the connection will be closed.

    Parameters

    • url: string
    • onRecv: WxEndRecvFn
    • Optionaloptions: WxWindowOpenOptions

    Returns Promise<WxResult<WxEnd>>