Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JSBridgeCore Abstract

jsBridge 基础类

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns JSBridgeCore

Properties

webViewType

webViewType: WebViewTypeEnum = WebViewTypeEnum.Unsupported

当前容器类型

Methods

Abstract actionShare

  • actionShare(shareConfig: Partial<ShareConfig>): Promise<JSBridgeReturnType<boolean>>

  • 设置分享配置。

    Parameters

    • shareConfig: Partial<ShareConfig>

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract callAndBackfeed

  • callAndBackfeed<T>(schemeUrl: string): Promise<JSBridgeReturnType<false | T>>

  • 原子方法 callAndBackfeed()。

    Type Parameters

    • T

    Parameters

    • schemeUrl: string

    Returns Promise<JSBridgeReturnType<false | T>>

Abstract callAndListen

  • callAndListen<T>(schemeUrl: string, callback: ((data: T) => void)): Promise<JSBridgeReturnType<false | (() => void)>>

  • 原子方法 callAndListen()。

    Type Parameters

    • T

    Parameters

    • schemeUrl: string
    • callback: ((data: T) => void)
        • (data: T): void

        • Parameters

          • data: T

          Returns void

    Returns Promise<JSBridgeReturnType<false | (() => void)>>

    销毁注册的事件监听。

Abstract closeLoading

  • closeLoading(): Promise<JSBridgeReturnType<boolean>>

  • 关闭 WebView 进度条

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract closeWebView

  • closeWebView(): Promise<JSBridgeReturnType<boolean>>

  • 关闭当前 WebView。

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract createCacheProxyUrl

  • createCacheProxyUrl(urls: string | string[]): string[]

  • 生成一个缓存代理的地址。

    Parameters

    • urls: string | string[]

    Returns string[]

Abstract detectMicro

  • detectMicro(): Promise<JSBridgeReturnType<boolean>>

  • 监测麦克风是否授权。

    Returns Promise<JSBridgeReturnType<boolean>>

emit

  • emit<K>(name: K, ...data: Parameters<WebViewEventMap[K]>): boolean

  • 触发事件

    Type Parameters

    • K extends keyof WebViewEventMap

      预设的监听事件名称

    Parameters

    • name: K

      事件类型

    • Rest ...data: Parameters<WebViewEventMap[K]>

      触发事件的数据

    Returns boolean

    canceled 是否被触发取消

Abstract getBangsHeight

  • getBangsHeight(): Promise<JSBridgeReturnType<number | false>>

  • 获取因 '刘海'、'挖孔' 等屏幕占用的高度。

    Returns Promise<JSBridgeReturnType<number | false>>

Abstract getDeviceInfo

  • getDeviceInfo(): Promise<JSBridgeReturnType<false | DeviceInfo>>

  • 获取当前设备的信息。

    Returns Promise<JSBridgeReturnType<false | DeviceInfo>>

Abstract getUserInfo

  • getUserInfo(): Promise<JSBridgeReturnType<false | UserInfo>>

  • 获取用户信息。

    Returns Promise<JSBridgeReturnType<false | UserInfo>>

Abstract getWebViewState

  • getWebViewState(): Promise<JSBridgeReturnType<false | WebViewState>>

  • 获取当前 WebView 的实时状态。

    Returns Promise<JSBridgeReturnType<false | WebViewState>>

hasListener

  • hasListener(name: keyof WebViewEventMap): boolean

  • 判断是否注册了事件

    Parameters

    • name: keyof WebViewEventMap

      事件类型

    Returns boolean

Abstract keepScreenLight

  • keepScreenLight(enable: boolean): Promise<JSBridgeReturnType<boolean>>

  • 是否保持屏幕常亮（不息屏）。

    Parameters

    • enable: boolean

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract loadProgress

  • loadProgress(progress: number): Promise<JSBridgeReturnType<boolean>>

  • WebView 进度条。

    Parameters

    • progress: number

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract login

  • login(): Promise<JSBridgeReturnType<false | UserInfo>>

  • 登录：登录成功后返回值为当前登录的用户信息。

    Returns Promise<JSBridgeReturnType<false | UserInfo>>

Abstract logout

  • logout(): Promise<JSBridgeReturnType<boolean>>

  • 登出：用户退出登录。

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract minimize

  • minimize(): Promise<JSBridgeReturnType<boolean>>

  • 最小化。

    Returns Promise<JSBridgeReturnType<boolean>>

off

  • off<K>(name?: K, callback?: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>)): void

  • 解除事件

    如果 name 不传的话解除对应所有事件 如果 name, callback 不传的话解除所有name的所有事件

    Type Parameters

    • K extends keyof WebViewEventMap

      预设的监听事件名称

    Parameters

    • Optional name: K

      事件类型

    • Optional callback: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>)

      事件回调函数

        • (...args: Parameters<WebViewEventMap[K]>): ReturnType<WebViewEventMap[K]>

        • Parameters

          • Rest ...args: Parameters<WebViewEventMap[K]>

          Returns ReturnType<WebViewEventMap[K]>

    Returns void

on

  • on<K>(name: K, callback: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>), once?: boolean): (() => void)

  • 注册事件

    Type Parameters

    • K extends keyof WebViewEventMap

      预设的监听事件名称

    Parameters

    • name: K

      事件类型

    • callback: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>)

      事件回调函数

        • (...args: Parameters<WebViewEventMap[K]>): ReturnType<WebViewEventMap[K]>

        • Parameters

          • Rest ...args: Parameters<WebViewEventMap[K]>

          Returns ReturnType<WebViewEventMap[K]>

    • Optional once: boolean

      是否只执行一次

    Returns (() => void)

    解除事件

      • (): void

      • 注册事件

        Returns void

        解除事件

once

  • once<K>(name: K, callback: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>)): (() => void)

  • 注册事件(是否只执行一次)

    Type Parameters

    • K extends keyof WebViewEventMap

      预设的监听事件名称

    Parameters

    • name: K

      事件类型

    • callback: ((...args: Parameters<WebViewEventMap[K]>) => ReturnType<WebViewEventMap[K]>)

      事件回调函数

        • (...args: Parameters<WebViewEventMap[K]>): ReturnType<WebViewEventMap[K]>

        • Parameters

          • Rest ...args: Parameters<WebViewEventMap[K]>

          Returns ReturnType<WebViewEventMap[K]>

    Returns (() => void)

    解除事件

      • (): void

      • 注册事件(是否只执行一次)

        Returns void

        解除事件

Abstract openWebView

  • openWebView(url: string, way: OpenWebViewEnum): Promise<JSBridgeReturnType<boolean>>

  • 开启新的 WebView。

    Parameters

    • url: string
    • way: OpenWebViewEnum

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract preload

  • preload(urls: string[]): Promise<JSBridgeReturnType<boolean>>

  • 预载资源。

    Parameters

    • urls: string[]

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract ready

  • ready(): Promise<JSBridgeReturnType<boolean>>

  • 状态判断。

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract saveImage2Album

  • saveImage2Album(base64: string): Promise<JSBridgeReturnType<boolean>>

  • 保存图片到用户相册。

    Parameters

    • base64: string

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract setLeftTopBackButton

  • setLeftTopBackButton(enable: boolean): Promise<JSBridgeReturnType<boolean>>

  • 设置左上角返回按钮。

    Parameters

    • enable: boolean

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract setOrientation

  • setOrientation(orientation: OrientationEnum): Promise<JSBridgeReturnType<boolean>>

  • 设置屏幕的方向。

    Parameters

    • orientation: OrientationEnum

    Returns Promise<JSBridgeReturnType<boolean>>

Abstract shock

  • shock(duration?: number): Promise<JSBridgeReturnType<boolean>>

  • 震动。

    Parameters

    • Optional duration: number

    Returns Promise<JSBridgeReturnType<boolean>>