JSBridgeApp | @realsee/jsbridge-x

App 客户端 JSBridge。 iOS WKWebView Android WebView

Hierarchy

JSBridgeCore
- JSBridgeApp

Constructors

constructor

new JSBridgeApp(options?: Partial<JSBridgeOptions>): JSBridgeApp

Overrides JSBridgeCore.constructor
- Defined in app/index.ts:30
Parameters
- options: Partial<JSBridgeOptions> = {}
Returns JSBridgeApp

Properties

Private _controller

_controller: BaseController

options

options: JSBridgeOptions

webViewType

webViewType: WebViewTypeEnum

当前容器类型

Methods

actionShare

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

Overrides JSBridgeCore.actionShare
- Defined in app/index.ts:120
设置分享配置。

Parameters
- shareConfig: Partial<ShareConfig>
Returns Promise<JSBridgeReturnType<boolean>>

callAndBackfeed

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

Overrides JSBridgeCore.callAndBackfeed
- Defined in app/index.ts:63
原子方法 callAndBackfeed()。

Type Parameters
- T
Parameters
- schemeUrl: string
Returns Promise<JSBridgeReturnType<false | T>>

callAndListen

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

Overrides JSBridgeCore.callAndListen
- Defined in app/index.ts:67
原子方法 callAndListen()。

Type Parameters
- T
Parameters
- schemeUrl: string
- callback: ((data: T) => void)
  - - (data: T): void
    - Parameters
      - data: T
      Returns void
Returns Promise<JSBridgeReturnType<false | (() => void)>>
销毁注册的事件监听。

closeLoading

closeLoading(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.closeLoading
- Defined in app/index.ts:96
关闭 WebView 进度条

Returns Promise<JSBridgeReturnType<boolean>>

closeWebView

closeWebView(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.closeWebView
- Defined in app/index.ts:108
关闭当前 WebView。

Returns Promise<JSBridgeReturnType<boolean>>

createCacheProxyUrl

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

Overrides JSBridgeCore.createCacheProxyUrl
- Defined in app/index.ts:164
生成一个缓存代理的地址。

Parameters
- urls: string | string[]
Returns string[]

detectMicro

detectMicro(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.detectMicro
- Defined in app/index.ts:149
监测麦克风是否授权。

Returns Promise<JSBridgeReturnType<boolean>>

emit

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

Inherited from JSBridgeCore.emit
- Defined in utils/Subscribe.ts:113
触发事件

Type Parameters
- K extends keyof WebViewEventMap
  
  预设的监听事件名称
Parameters
- name: K
  
  事件类型
- Rest ...data: Parameters<WebViewEventMap[K]>
  
  触发事件的数据
Returns boolean
canceled 是否被触发取消

getBangsHeight

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

Overrides JSBridgeCore.getBangsHeight
- Defined in app/index.ts:79
获取因 '刘海'、'挖孔' 等屏幕占用的高度。

Returns Promise<JSBridgeReturnType<number | false>>

getDeviceInfo

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

Overrides JSBridgeCore.getDeviceInfo
- Defined in app/index.ts:124
获取当前设备的信息。

Returns Promise<JSBridgeReturnType<false | DeviceInfo>>

getUserInfo

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

Overrides JSBridgeCore.getUserInfo
- Defined in app/index.ts:128
获取用户信息。

Returns Promise<JSBridgeReturnType<false | UserInfo>>

getWebViewState

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

Overrides JSBridgeCore.getWebViewState
- Defined in app/index.ts:132
获取当前 WebView 的实时状态。

Returns Promise<JSBridgeReturnType<false | WebViewState>>

hasListener

hasListener(name: keyof WebViewEventMap): boolean

Inherited from JSBridgeCore.hasListener
- Defined in utils/Subscribe.ts:40
判断是否注册了事件

Parameters
- name: keyof WebViewEventMap
  
  事件类型
Returns boolean

keepScreenLight

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

Overrides JSBridgeCore.keepScreenLight
- Defined in app/index.ts:104
是否保持屏幕常亮（不息屏）。

Parameters
- enable: boolean
Returns Promise<JSBridgeReturnType<boolean>>

loadProgress

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

Overrides JSBridgeCore.loadProgress
- Defined in app/index.ts:91
WebView 进度条。

Parameters
- progress: number
Returns Promise<JSBridgeReturnType<boolean>>

login

Overrides JSBridgeCore.login
- Defined in app/index.ts:135
登录：登录成功后返回值为当前登录的用户信息。

Returns Promise<JSBridgeReturnType<false | UserInfo>>

logout

logout(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.logout
- Defined in app/index.ts:145
登出：用户退出登录。

Returns Promise<JSBridgeReturnType<boolean>>

minimize

minimize(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.minimize
- Defined in app/index.ts:87
最小化。

Returns Promise<JSBridgeReturnType<boolean>>

off

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

Inherited from JSBridgeCore.off
- Defined in utils/Subscribe.ts:86
解除事件

如果 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)

Inherited from JSBridgeCore.on
- Defined in utils/Subscribe.ts:54
注册事件

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)

Inherited from JSBridgeCore.once
- Defined in utils/Subscribe.ts:73
注册事件(是否只执行一次)

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
    解除事件

openWebView

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

Overrides JSBridgeCore.openWebView
- Defined in app/index.ts:112
开启新的 WebView。

Parameters
- url: string
- way: OpenWebViewEnum
Returns Promise<JSBridgeReturnType<boolean>>

preload

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

Overrides JSBridgeCore.preload
- Defined in app/index.ts:153
预载资源。

Parameters
- urls: string[]
Returns Promise<JSBridgeReturnType<boolean>>

ready

ready(): Promise<JSBridgeReturnType<boolean>>

Overrides JSBridgeCore.ready
- Defined in app/index.ts:59
状态判断。

Returns Promise<JSBridgeReturnType<boolean>>

saveImage2Album

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

Overrides JSBridgeCore.saveImage2Album
- Defined in app/index.ts:116
保存图片到用户相册。

Parameters
- base64: string
Returns Promise<JSBridgeReturnType<boolean>>

setLeftTopBackButton

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

Overrides JSBridgeCore.setLeftTopBackButton
- Defined in app/index.ts:71
设置左上角返回按钮。

Parameters
- Optional enable: boolean
Returns Promise<JSBridgeReturnType<boolean>>

setOrientation

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

Overrides JSBridgeCore.setOrientation
- Defined in app/index.ts:100
设置屏幕的方向。

Parameters
- orientation: OrientationEnum
Returns Promise<JSBridgeReturnType<boolean>>

shock

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

Overrides JSBridgeCore.shock
- Defined in app/index.ts:83
震动。

Parameters
- duration: number = 4
Returns Promise<JSBridgeReturnType<boolean>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Partial<JSBridgeOptions> = {}

Returns JSBridgeApp

Properties

Private _controller

options

webViewType

Methods

actionShare

Parameters

shareConfig: Partial<ShareConfig>

Returns Promise<JSBridgeReturnType<boolean>>

callAndBackfeed

Type Parameters

T

Parameters

schemeUrl: string

Returns Promise<JSBridgeReturnType<false | T>>

callAndListen

Type Parameters

T

Parameters

schemeUrl: string

callback: ((data: T) => void)

Parameters

data: T

Returns void

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

closeLoading

Returns Promise<JSBridgeReturnType<boolean>>

closeWebView

Returns Promise<JSBridgeReturnType<boolean>>

createCacheProxyUrl

Parameters

urls: string | string[]

Returns string[]

detectMicro

Returns Promise<JSBridgeReturnType<boolean>>

emit

Type Parameters

K extends keyof WebViewEventMap

Parameters

name: K

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

Returns boolean

getBangsHeight

Returns Promise<JSBridgeReturnType<number | false>>

getDeviceInfo

Returns Promise<JSBridgeReturnType<false | DeviceInfo>>

getUserInfo

Returns Promise<JSBridgeReturnType<false | UserInfo>>

getWebViewState

Returns Promise<JSBridgeReturnType<false | WebViewState>>

hasListener

Parameters

name: keyof WebViewEventMap

Returns boolean

keepScreenLight

Parameters

enable: boolean

Returns Promise<JSBridgeReturnType<boolean>>

loadProgress

Parameters

progress: number

Returns Promise<JSBridgeReturnType<boolean>>

login

Returns Promise<JSBridgeReturnType<false | UserInfo>>

logout

Returns Promise<JSBridgeReturnType<boolean>>

minimize

Returns Promise<JSBridgeReturnType<boolean>>

off

Type Parameters