JSAPI概览

名称

功能说明

Android

iOS

WVBase.checkWindVaneSDK

判断指定版本号与当前WindVaneSDK版本号的大小关系。

N

Y

WVBase.copyToClipboard

将指定的文本复制到剪贴板。

Y

Y

WVBase.isInstall

判断是否已安装指定的应用程序。

Y

Y

WVBase.isAppsInstalled

判断是否已安装指定的多个应用程序。

Y

Y

WVBase.isWindVaneSDK

用于获取当前WindVaneSDK的版本。

Y

Y

WVBase.notify

在 document 引发指定名称和参数的事件

N

Y

WVBase.openBrowser

打开指定URL的Safari新窗口。

N

Y

WVBase.setBackgroundColor

设置WebView的背景颜色。

N

Y

WVBase.canIUse

判断传入的API在当前版本是否支持。

Y

Y

WVMiniApp.close

关闭小程序。

Y

Y

名称

功能说明

Android

iOS

WVNavigator.pop

退出当前界面

Y

Y

WVNavigator.push

打开一个新的小程序界面

Y

Y

名称

功能说明

Android

iOS

WVUI.showLoadingBox

显示一个加载提示框。

Y

Y

WVUI.hideLoadingBox

隐藏加载提示框。

Y

Y

WVUI.hideKeyboard

隐藏键盘。

Y

Y

名称

功能说明

Android

iOS

WVUIToast.toast

显示一个Toast（显示在屏幕中央的简单提示）。

Y

Y

名称

功能说明

Android

iOS

WVUIDialog.alert

显示一个警告框。

Y

Y

WVUIDialog.confirm

显示一个确认框。

Y

Y

WVUI.enableAlertBeforeUnload

开启小程序页面返回询问对话框，开启后当用户使用返回键尝试关闭小程序页面时，会弹出"是否确认离开"的对话框。

Y

Y

WVUI.disableAlertBeforeUnload

关闭小程序页面返回询问对话框。

Y

Y

WVUIDialog.prompt

弹出一个对话框，让用户在对话框内输入文本。

Y

Y

WVUIDialog.showAuthGuide

通过权限引导模块以图文形式向用户弹出对话框，引导用户打开相应的权限。

Y

Y

WVUIDatePicker.show

显示一个日期选择器，可以设置默认选择日期，未设置则默认当天。

Y

Y

名称

功能说明

Android

iOS

WVUIActionSheet.show

显示一个ActionSheet（显示在屏幕下方的动作列表）。

Y

Y

名称

功能说明

Android

iOS

WVNavigationBar.update

动态设置当前页面的标题栏。

Y

Y

WVNavigationBar.getHeight

获取小程序标题栏高度。

Y

Y

名称

功能说明

Android

iOS

WVImage.saveImage

允许保存HTTP(S)地址或者base64格式的图片到相册中。

Y

Y

名称

功能说明

Android

iOS

WVVideo.chooseVideo

拍摄视频或从手机相册中选视频。

Y

Y

WVVideo.saveVideoToPhotosAlbum

保存视频到系统相册。

Y

Y

名称

功能说明

Android

iOS

WVAudio.playSystemSound

播放指定的系统声音。

N

Y

名称

功能说明

Android

iOS

WVCamera.takePhoto

用户自选调用相机拍照或者直接从相册选择照片，得到照片后可以指定是否自动上传照片。需要Native端上实现上传协议。

Y

Y

WVCamera.confirmUploadPhoto

确认上传照片。

Y

Y

名称

功能说明

Android

iOS

WVStorage.setItem

将数据存储在本地缓存中指定的 key中。

Y

Y

WVStorage.getItem

从本地缓存中异步获取指定key的内容。

Y

Y

WVStorage.removeItem

从本地缓存中删除指定key的内容。

Y

Y

WVStorage.clearStorage

异步清除缓存。

Y

Y

WVStorage.clearStorageSync

同步清除缓存。

Y

Y

名称

功能说明

Android

iOS

WVFile.write

将指定的文件内容写入磁盘。

Y

Y

WVFile.read

读取指定文件的内容。

Y

Y

WVFile.getFileInfo

获取文件信息。

Y

Y

WVFile.downloadFile

下载文件资源到本地。

Y

Y

WVFile.uploadFile

上传文件至指定服务器URL。

Y

Y

名称

功能说明

Android

iOS

WVLocation.getLocation

获取当前的地理位置。

Y

Y

WVLocation.searchLocation

搜索给定地址的地理位置经纬度。

N

Y

名称

功能说明

Android

iOS

WVCookie.read

读取指定URL的所有Cookie。

Y

Y

WVCookie.write

写入指定的Cookie。

Y

Y

名称

功能说明

Android

iOS

WVSystem.getSystemInfo

获取手机系统信息。

Y

Y

WVSystem.getSystemInfoSync

获取手机系统信息同步方法。

Y

Y

名称

功能说明

Android

iOS

WVNativeDetector.isSimulator

获取当前环境是否是模拟器。

Y

Y

WVNativeDetector.getCurrentUsage

获取当前的CPU和内存使用率信息。

Y

Y

WVNativeDetector.getDeviceYear

获取设备的发布日期，可以用于估算设备的性能。iOS可以基本准确地获得设备的发布日期，估算Android设备性能。

Y

Y

WVNativeDetector.getModelInfo

获取设备型号等信息。

Y

Y

WVNativeDetector.getSafeAreaInsets

获取当前页面的安全区域信息，仅适用于全屏页面。

N

Y

名称

功能说明

Android

iOS

WVNetwork.getNetworkType

获取当前网络类型。

Y

Y

名称

功能说明

Android

iOS

WVScreen.getOrientation

返回当前Activity/ViewController的显示方向（横屏/竖屏）。

Y

Y

WVScreen.setOrientation

设置当前ViewController/Activity的显示方向（横屏/竖屏）。

Y

Y

WVScreen.setScreenBrightness

设置屏幕亮度。

Y

Y

WVScreen.getScreenBrightness

获取屏幕亮度。

Y

Y

名称

功能说明

Android

iOS

WVScreenCapture.capture

截取当前WebView显示的部分为图片。

Y

Y

名称

功能说明

Android

iOS

WVMotion.listenBlow

开启吹气动作的监听。

Y

Y

WVMotion.stoplistenBlow

停止吹气动作的监听。

Y

Y

WVMotion.listenGyro

开启或关闭陀螺仪的监听。

Y

Y

WVMotion.listeningShake

开启或关闭摇一摇的监听。

Y

Y

WVMotion.vibrate

令手机震动。

Y

Y

WVMotion.startAccelerometer

开始监听加速度数据。

Y

Y

WVMotion.stopAccelerometer

停止监听加速度数据。

Y

Y

WVMotion.startCompass

开始监听罗盘数据。

Y

Y

WVMotion.stopCompass

停止监听罗盘数据。

Y

Y

名称

功能说明

Android

iOS

WVNotification.beep

令手机蜂鸣。

Y

Y

名称

功能说明

Android

iOS

WVCall.dial

调起拨号键盘。

Y

Y

WVCall.call

直接拨打电话。

Y

Y

名称

功能说明

Android

iOS

WVApplication.appState

返回当前应用的状态（是否在前台）。

N

Y

WVApplication.getNotificationSettings

返回当前应用的通知状态。

N

Y

WVApplication.openSettings

打开当前应用的设置页面。

N

Y

名称

功能说明

Android

iOS

WVContacts.askAuth

请求访问通讯录的权限。

N

Y

WVContacts.authStatus

获取当前对于通讯录的访问权限状态。

N

Y

WVContacts.choose

拉起通讯录列表，用户选择一个联系人之后将联系人的名字和电话返回给H5端。

Y

Y

WVContacts.find

通过指定的名字和电话号码查找通讯录。

Y

Y

WVContacts.addPhoneContact

添加联系人。

Y

Y

名称

功能说明

Android

iOS

WVScan.scan

扫一扫功能。

Y

Y

名称

功能说明

Android

iOS

WVBattery.getBatteryInfo

获取电量的异步接口。

Y

Y

WVBattery.getBatteryInfoSync

获取电量的同步接口。

Y

Y

名称

功能说明

Android

iOS

WVBluetooth.requestAuthorization

申请蓝牙相关权限并打开蓝牙。

Y

Y

WVBluetooth.scan

寻找蓝牙低功耗(LE)设备。

Y

Y

WVBluetooth.stopScan

停止寻找蓝牙设备。

Y

Y

WVBluetooth.connect

连接指定蓝牙地址的蓝牙设备。

Y

Y

WVBluetooth.disconnect

同已连接的蓝牙设备断开连接。

Y

Y

WVBluetooth.getServices

开始查找低功耗蓝牙设备的服务

Y

Y

WVBluetooth.getCharacteristics

获取低功耗蓝牙设备的所有特征值。

Y

Y

WVBluetooth.writeValue

向已连接的低功耗蓝牙设备写入指定的特征值。

Y

Y

WVBluetooth.readValue

从已连接的低功耗蓝牙设备中读取指定特征值。

Y

Y

WVBluetooth.startNotifications

开启特征值变化通知。

Y

Y

WVBluetooth.stopNotifications

关闭特征值变化通知。

Y

Y

名称

功能说明

Android

iOS

WVStandardEventCenter.postNotificationToNative

小程序端向Native端发送事件，具体的事件名称可以是与Native业务方商议一致的任意名称

Y

Y

名称

功能说明

Android

iOS

WVReportor.reportDomLoad

报告当前页面的首字节时间和DomLoad事件时间。

Y

Y

WVReportor.reportError

报告当前页面的JS错误。

Y

Y

名称

功能说明

Android

iOS

WVUser.getUserInfo

获取当前登录的用户信息，小程序容器内部会使用用户信息进行授权管理。

Y

Y

名称

功能说明

Android

iOS

WindVaneReady

当页面加载完毕后，WindVane会引发WindVaneReady事件，页面可以监听这一事件，获取页面加载状态。

Y

Y

Background

当应用被切换到后台（如切换应用、打开通知栏等操作）时，WindVane会引发WV.Event.APP.Background事件，页面可以监听这一事件，获知应用已被切换到后台。

Y

Y

Active

当应用被切换到后台再切换回来时，WindVane会引发WV.Event.APP.Active事件，页面可以监听这一事件，获知应用已经被激活。

Y

Y

Pull Refresh

WindVane iOS在默认情况下，会自动启用下拉刷新。下拉刷新默认启用，若需关闭需手动操作。

N

Y

Infinite Scroll

当页面滚动到最下方，可以通过无限滚动来动态的加载新内容。无限滚动默认关闭，若需启用需手动操作。

N

Y