本文介绍uni-app小程序JSAPI的能力和使用方式，便于您在使用uni-app小程序JSAPI时参考。
本文介绍的JSAPI是参见uni-app官网的JSAPI。本文列举的JSAPI适用于Superapp的uni-app小程序，未列举的JSAPI均不适用。调用此类JSAPI的小程序支持投放到您自己开发的Superapp平台。
基础
名称 | 功能说明 | 链接 |
uni.base64ToArrayBuffer | 将Base64字符串转成ArrayBuffer对象。 | |
uni.arrayBufferToBase64 | 将ArrayBuffer对象转成Base64字符串。 | |
uni.getLaunchOptionsSync | 获取启动时的参数。 | |
uni.getEnterOptionsSync | 获取启动时的参数。 | |
uni.addInterceptor | 添加拦截器。 | |
uni.removeInterceptor | 删除拦截器。 | |
uni.canIUse | 判断应用的 API，回调，参数，组件等是否在当前版本可用。 |
网络
发起请求
名称 | 功能说明 | 链接 |
uni.request | 发起网络请求。 |
上传/下载
名称 | 功能说明 | 链接 |
uni.uploadFile | 将本地资源上传到开发者服务器，客户端发起一个 | |
uni.downloadFile | 下载文件资源到本地，客户端直接发起一个 |
WebSocket
名称 | 功能说明 | 链接 |
uni.connectSocket | 创建一个WebSocket连接。 | |
uni.onSocketOpen | 监听WebSocket连接打开事件。 | |
uni.onSocketError | 监听WebSocket错误。 | |
uni.sendSocketMessage | 通过WebSocket连接发送数据，需要先调用uni.connectSocket，并在uni.onSocketOpen回调之后才能发送。 | |
uni.onSocketMessage | 监听WebSocket接受到服务器的消息事件。 | |
uni.closeSocket | 关闭WebSocket连接。 | |
uni.onSocketClose | 监听WebSocket关闭。 |
SocketTask
名称 | 功能说明 | 链接 |
SocketTask.onMessage | 监听WebSocket接收到服务器的消息事件。 | |
SocketTask.send | 通过WebSocket连接发送数据。 | |
SocketTask.close | 关闭WebSocket连接。 | |
SocketTask.onOpen | 监听WebSocket连接打开事件。 | |
SocketTask.onClose | 监听WebSocket连接关闭事件。 | |
SocketTask.onError | 监听WebSocket错误事件。 |
页面路由
名称 | 功能说明 | 链接 |
uni.navigateTo | 保留当前页面，跳转到应用内的某个页面，使用uni.navigateBack可以返回到原页面。 | |
uni.redirectTo | 关闭当前页面，跳转到应用内的某个页面。 | |
uni.reLaunch uni.reLaunch | 关闭所有页面，打开到应用内的某个页面。 | |
uni.switchTab uni.switchTab | 跳转到TabBar页面，并关闭其他所有非TabBar页面 | |
uni.navigateBack uni.navigateBack | 关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages() 获取当前的页面栈，决定需要返回几层。 | |
uni.preloadPage uni.preloadPage | 预加载页面，是一种性能优化技术。被预载的页面，在打开时速度更快。 |
EventChannel
名称 | 功能说明 | 链接 |
EventChannel.emit | 触发一个事件。 | |
EventChannel.off | 取消监听一个事件。 | |
EventChannel.on | 持续监听一个事件。 | |
EventChannel.once | 监听一个事件一次，触发后失效。 |
窗口动画
窗口的显示/关闭动画效果，支持在 API、组件、pages.json 中配置，优先级为：API = 组件 > pages.json，详细说明请参见窗口动画。
页面通讯
名称 | 功能说明 | 链接 |
uni.$emit | 触发全局的自定义事件，附加参数都会传给监听器回调函数 | |
uni.$on | 监听全局的自定义事件，事件由 uni.$emit触发，回调函数会接收事件触发函数的传入参数。 | |
uni.$once | 监听全局的自定义事件，事件由 uni.$emit触发，但仅触发一次，在第一次触发之后移除该监听器。 | |
uni.$off | 移除全局自定义事件监听器。 |
subNVue原生子窗体
名称 | 功能说明 | 链接 |
uni.getSubNVueById | 通过ID获取subNVues原生子窗体的实例。 | |
uni.getCurrentSubNVue | 在一个subnvue窗体的nvue页面代码中，获取当前subNVues原生子窗体的实例。 | |
subNVue.show | 显示原生子窗体。 | |
subNVue.hide | 隐藏原生子窗体。 |
数据缓存
名称 | 功能说明 | 链接 |
uni.setStorage | 将数据存储在本地缓存中指定的key中，会覆盖掉原来该key对应的内容，这是一个异步接口。 | |
uni.setStorageSync | 将数据存储在本地缓存中指定的key中，会覆盖掉原来该key对应的内容，这是一个同步接口。 | |
uni.getStorage | 从本地缓存中异步获取指定key对应的内容。 | |
uni.getStorageSync | 从本地缓存中同步获取指定key对应的内容。 | |
uni.getStorageInfo | 异步获取当前storage的相关信息。 | |
uni.getStorageInfoSync | 同步获取当前storage的相关信息。 | |
uni.removeStorage | 从本地缓存中异步移除指定key。 | |
uni.removeStorageSync | 从本地缓存中同步移除指定key。 | |
uni.clearStorage | 清理本地数据缓存。 | |
uni.clearStorageSync | 同步清理本地数据缓存。 |
位置
获取位置
名称 | 功能说明 | 链接 |
uni.getLocation | 获取当前的地理位置、速度。 | |
uni.chooseLocation | 打开地图选择位置。 | |
plus.geolocation.getCurrentPosition | 获取当前设备位置信息。 |
更新位置
名称 | 功能说明 | 链接 |
uni.onLocationChange | 监听实时地理位置变化事件，需结合uni.startLocationUpdate或 uni.startLocationUpdateBackground使用。 | |
uni.offLocationChange | 关闭监听实时位置变化，前后台都停止消息接收。 | |
uni.onLocationChangeError | 监听持续定位接口返回失败时触发。 | |
uni.offLocationChangeError | 取消注册位置更新错误回调。 | |
uni.startLocationUpdate | 开启小程序进入前台时接收位置消息。 | |
uni.stopLocationUpdate | 关闭监听实时位置变化，前后台都停止消息接收。 | |
uni.startLocationUpdateBackground | 开始监听实时地理位置信息变化事件，小程序进入前后台时均接收实时地理位置信息。 | |
plus.geolocation.watchPosition | 监听设备位置变化信息。 | |
plus.geolocation.clearWatch | 关闭监听设备位置信息。 |
地图组件控制
名称 | 功能说明 | 链接 |
uni.createMapContext | 创建并返回map上下文mapContext对象。在自定义组件下，第二个参数传入组件实例this，以操作组件内<map>组件。 | |
plus.maps.openSysMap | 调用系统第三方程序进行导航。 | |
plus.maps.create | 创建Map对象。 | |
plus.maps.getMapById | 查找已经创建的Map对象。 |
媒体
图片
名称 | 功能说明 | 链接 |
uni.chooseImage | 从本地相册选择图片或使用相机拍照。 | |
uni.previewImage | 预览图片。 | |
uni.closePreviewImage | 关闭预览图片。 | |
uni.getImageInfo | 获取图片信息。 | |
uni.saveImageToPhotoAlbum | 保存图片到系统相册。 | |
uni.compressImage | 压缩图片接口，可选压缩质量。 | |
plus.gallery.pick | 从本地相册选择图片或视频。 | |
plus.gallery.save | 保存文件到系统相册中。 |
摄像头
名称 | 功能说明 | 链接 |
plus.camera.getCamera | 获取摄像头管理对象。 |
录音管理
名称 | 功能说明 | 链接 |
ni.getRecorderManager | 获取全局唯一的录音管理器recorderManager。 | |
plus.audio.getRecorder | 获取当前设备的录音对象。 | |
plus.audio.createPlayer | 创建音频播放器对象。 |
背景音频播放管理
名称 | 功能说明 | 链接 |
uni.getBackgroundAudioManager | 获取全局唯一的背景音频管理器backgroundAudioManager。 |
音频组件控制
名称 | 功能说明 | 链接 |
uni.createInnerAudioContext | 创建并返回内部audio上下文innerAudioContext对象。 |
视频
名称 | 功能说明 | 链接 |
uni.chooseVideo https://en.uniapp.dcloud.io/api/media/video.html | 拍摄视频或从手机相册中选视频，返回视频的临时文件路径。 | |
uni.saveVideoToPhotosAlbum | 保存视频到系统相册。 | |
uni.getVideoInfo | 获取视频详细信息。 | |
uni.compressVideo | 压缩视频接口。 | |
plus.video.createVideoPlayer | 创建VideoPlayer对象。 | |
plus.video.createLivePusher | 创建LibePusher对象。 | |
plus.video.getVideoPlayerById | 查找已经创建的VideoPlayer对象。 | |
plus.video.getLivePusherById | 查找已经创建的LibePusher对象。 |
视频组件控制
名称 | 功能说明 | 链接 |
uni.createVideoContext | 创建并返回video上下文videoContext对象。在自定义组件下，第二个参数传入组件实例this，以操作组件内<video>组件。 |
设备
系统
名称 | 功能说明 | 链接 |
uni.getSystemInfo | 异步获取系统信息。 | |
uni.getSystemInfoSync | 同步获取系统信息。 | |
uni.getDeviceInfo | 获取设备基础信息。 | |
uni.getWindowInfo | 获取窗口信息。 | |
uni.getSystemSetting | 获取设备设置。 | |
uni.openAppAuthorizeSetting | 跳转系统授权管理页。 | |
plus.device.beep | 发出蜂鸣声。 | |
plus.device.getInfo | 获取设备信息。 | |
plus.device.getOAID | 获取匿名设备标识符。 | |
plus.device.getVAID | 获取开发者匿名设备标识。 | |
plus.device.getAAID | 获取应用匿名设备标识符。 | |
plus.device.getDeviceId | 获取DCloud匿名设备标识符。 | |
plus.device.getVolume | 获取设备系统音量。 | |
plus.device.setVolume | 设置设备的系统音量。 | |
plus.device.isWakelock | 获取程序是都一直保持唤醒状态。 | |
plus.device.setWakelock | 设置应用是否保持唤醒状态。 | |
plus.device.virate | 设备振动。 | |
plus.navigator.checkPermission | 检查运行环境的权限。 | |
plus.navigator.closeSplashscreen | 关闭应用启动界面。 | |
plus.navigator.hasNotchInScreen | 查询设备是否为刘海屏。 | |
plus.navigator.hasSplashscreen | 查询应用启动界面是否已关闭。 | |
plus.navigator.updateSplashscreen | 更新程序启动界面。 | |
plus.navigator.createShortcut | 创建应用快捷方式。 | |
plus.navigator.hasShortcut | 查询是否存在应用快捷方式。 | |
plus.navigator.hideSystemNavigation | 隐藏系统虚拟按键。 | |
plus.navigator.showSystemNavigation | 显示系统虚拟按键。 | |
plus.navigator.isBackground | 判断当前应用是否切换到后台。 | |
plus.navigator.isFullscreen | 判断应用当前是否全屏模式。 | |
plus.navigator.isLogs | 判断应用当前是否输出日志。 | |
plus.navigator.isRoot | 判断当前设备是否被Root破解。 | |
plus.navigator.isSimulator | 判断当前应用是否运行在模拟器中。 | |
plus.navigator.setFullscreen | 设置应用是否全屏显示。 | |
plus.navigator.setLogs | 设置应用是否输出日志。 | |
plus.navigator.setStatusBarBackground | 设置系统状态栏背景颜色。 | |
plus.navigator.getStatusBarBackground | 获取系统状态栏背景颜色。 | |
plus.navigator.setStatusBarStyle | 设置系统状态栏样式。 | |
plus.navigator.getStatusBarStyle | 获取系统状态栏样式。 | |
plus.navigator.getStatusbarHeight | 获取系统状态栏高度。 | |
plus.navigator.isImmersedStatusbar | 判断当前是否为沉浸式状态栏模式。 | |
plus.navigator.setUserAgent | 设置userAgent。 | |
plus.navigator.getUserAgent | 获取userAgent。 | |
plus.navigator.setCookie | 设置Cookie值。 | |
plus.navigator.getCookie | 获取Cookie值。 | |
plus.navigator.removeAllCookie | 删除应用所有Cookie值。 | |
plus.navigator.removeCookie | 删除应用Cookie。 | |
plus.navigator.removeSessionCooki | 删除应用所有会话期Cookie值。 | |
plus.navigator.getSafeAreaInsets | 获取应用的安全区域。 | |
plus.navigator.getOrientation | 获取应用的横竖屏状态。 | |
plus.navigator.getUIStyle | 获取系统外观样式（暗黑模式）。 | |
plus.navigator.getSignature | 获取应用的签名标识。 | |
plus.orientation.getCurrentOrientation | 获取当前设备的方向信息，包括alpha、beta、gamma三个方向信息。 | |
plus.orientation.watchOrientation | 监听设备方向信息的变化。 | |
plus.orientation.clearWatch | 关闭监听设备方向信息。 | |
plus.proximity.getCurrentProximity | 获取当前设备的接近距离信息。 | |
plus.proximity.watchProximity | 监听设备接近距离的变化。 | |
plus.proximity.clearWatch | 关闭监听设备接近距离变化。 | |
plus.runtime.agreePrivacy | 用户同意隐私政策。 | |
plus.runtime.disagreePrivacy | 用户不同意隐私政策。 | |
plus.runtime.isAgreePrivacy | 查询用户是否同意隐私政策。 | |
plus.runtime.showPrivacyDialog | 显示隐私政策框。 | |
plus.runtime.getProperty | 获取指定APPID对应的应用信息。 | |
plus.runtime.install | 安装应用。 | |
plus.runtime.quit | 退出应用。 | |
plus.runtime.restart | 重启当前应用。 | |
plus.runtime.setBadgeNumber | 设置应用图标上显示的角标数字。 | |
plus.runtime.openURL | 调用第三方程序打开指定URL。 | |
plus.runtime.openWeb | 使用内置WebView窗口打开URL。 | |
plus.runtime.openFile | 调用第三方程序打开指定文件。 | |
plus.runtime.processDirectPage | 处理直达页面链接参数. | |
plus.runtime.launchApplication | 调用第三方程序。 | |
plus.runtime.isApplicationExist | 判断第三方程序是否已存在。 | |
plus.runtime.isCustomLaunchPath | 判断是否自定义应用启动页面加载地址。 |
网络状态
名称 | 功能说明 | 链接 |
uni.getNetworkType | 获取网络类型。 | |
uni.onNetworkStatusChange | 监听网络状态变化。可使用uni.offNetworkStatusChange取消监听。 | |
uni.offNetwokrStatusChange | 取消监听网络状态变化。 |
系统主题
名称 | 功能说明 | 链接 |
uni.onThemeChange | 监听系统主题状态变化。 | |
uni.offThemeChange | 取消监听系统主题状态变化。 |
加速度
名称 | 功能说明 | 链接 |
uni.onAccelerometerChange | 监听加速度数据，频率：5次/秒，接口调用后会自动开始监听，可使用 uni.offAccelerometer取消监听。 | |
uni.offAccelerometerChange | 取消监听加速度数据。 | |
uni.startAccelerometer | 开始监听加速度数据。 | |
uni.stopAccelerometer | 停止监听加速度数据。 | |
plus.accelerometer.getCurrentAcceleration | 获取当前设备的加速度信息。 | |
plus.accelerometer.watchAcceleration | 监听设备加速度变化信息。 | |
plus.clearWatch | 关闭监听设备加速度信息。 |
罗盘
名称 | 功能说明 | 链接 |
uni.onCompassChange | 监听罗盘数据，频率：5次/秒，接口调用后会自动开始监听，可使用 uni.offCompassChange取消监听。 | |
uni.offCompassChange | 取消监听罗盘数据。 | |
uni.startCompass | 开始监听罗盘数据。 | |
uni.stopCompass | 停止监听罗盘数据。 |
拨打电话
名称 | 功能说明 | 链接 |
uni.makePhoneCall | 拨打电话 | |
plus.device.dial | 拨打电话 |
扫码
名称 | 功能说明 | 链接 |
uni.scanCode | 调起客户端扫码界面，扫码成功后返回对应的结果。 | |
plus.barcode.scan | 扫码识别图片中的条码。 | |
plus.barcode.create | 创建扫码识别控件对象。 | |
plus.barcode.getBarcodeById | 查找扫码识别控件对象。 |
剪切板
名称 | 功能说明 | 链接 |
uni.setClipboardData | 设置系统剪贴板的内容。 | |
uni.getClipboardData | 获取系统剪贴板内容。 |
屏幕亮度
名称 | 功能说明 | 链接 |
uni.setScreenBrightness | 设置屏幕亮度。 | |
uni.getScreenBrightness | 获取屏幕亮度。 | |
uni.setKeepScreenOn | 设置是否保持常亮状态。仅在当前应用生效，离开应用后设置失效。 |
用户截屏事件
名称 | 功能说明 | 链接 |
uni.onUserCaptureScreen | 监听用户主动截屏事件，用户使用系统截屏按键截屏时触发此事件。 | |
uni.offUserCaptureScreen | 用户主动截屏事件。取消事件监听。 | |
uni.setUserCaptureScreen | 开启/关闭防截屏。 |
振动
名称 | 功能说明 | 链接 |
uni.vibrate | 使手机发生振动。 | |
uni.vibrateLong | 使手机发生较长时间的振动（400ms）。 | |
uni.vibrateShort | 使手机发生较短时间的振动（15ms）。 |
手机联系人
名称 | 功能说明 | 链接 |
uni.addPhoneContact | 调用后，用户可以选择将该表单以“新增联系人”或“添加到已有联系人”的方式（APP端目前没有选择步骤，将直接写入），写入手机系统通讯录，完成手机通讯录联系人和联系方式的增加。 | |
plus.contacts.getAddressBook | 获取通讯录对象。 |
短信/邮件
名称 | 功能说明 | 链接 |
plus.messaging.createMessage | 创建消息对象。 | |
plus.messaging.sendMessage | 发送消息。 |
蓝牙
名称 | 功能说明 | 链接 |
uni.openBluetoothAdapter | 初始化蓝牙模块。 | |
uni.startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备。此操作比较耗费系统资源，请在搜索并连接到设备后调用 uni.stopBluetoothDevicesDiscovery方法停止搜索。 | |
uni.onBluetoothDeviceFound | 监听寻找到新设备的事件。 | |
uni.stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时，建议调用该接口停止蓝牙搜索。 | |
uni.onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件。 | |
uni.getConnectedBluetoothDevices | 根据uuid获取处于已连接状态的设备。 | |
uni.getBluetoothDevices | 获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备。 | |
uni.getBluetoothAdapterState | 获取本机蓝牙适配器状态。 | |
uni.closeBluetoothAdapter | 关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后，与 uni.openBluetoothAdapter成对调用。 | |
plus.bluetooth.closeBluetoothAdapter | 关闭蓝牙模块。 | |
plus.bluetooth.getBluetoothAdapterState | 获取蓝牙适配器状态。 | |
plus.bluetooth.getBluetoothDevices | 获取已搜索到的蓝牙设备。 | |
plus.bluetooth.getConnectedBluetoothDevices | 根据uuid获取处于已连接的设备。 | |
plus.bluetooth.onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件。 | |
plus.bluetooth.onBluetoothDeviceFound | 监听搜索到新设备的事件。 | |
plus.bluetooth.openBluetoothAdapter | 初始化蓝牙模块。 | |
plus.bluetooth.startBluetoothDevicesDiscovery | 开始搜索附近的蓝牙设备。 | |
plus.bluetooth.stopBluetoothDevicesDiscovery | 停止搜索附近的蓝牙设备。 |
低功耗蓝牙
名称 | 功能说明 | 链接 |
uni.setBLEMTU | 设置蓝牙最大传输单元。需在 uni.createBLEConnection调用成功后调用，mtu设置范围 (22,512)。安卓5.1以上有效 | |
uni.writeBLECharacteristicValue | 向低功耗蓝牙设备特征值中写入二进制数据。 | |
uni.readBLECharacteristicValue | 读取低功耗蓝牙设备的特征值的二进制数据值。 | |
uni.onBLEConnectionStateChange | 监听低功耗蓝牙连接状态的改变事件。 | |
uni.onBLECharacteristicValueChange | 监听低功耗蓝牙设备的特征值变化事件。 | |
uni.notifyBLECharacteristicValueChange | 启用低功耗蓝牙设备特征值变化时的 notify功能，订阅特征值。 | |
uni.getBLEDeviceServices | 获取蓝牙设备所有服务(service)。 | |
uni.getBLEDeviceRSSI | 获取蓝牙设备的信号强度。 | |
uni.getBLEDeviceCharacteristics | 获取蓝牙设备某个服务中所有特征值(characteristic)。 | |
uni.createBLEConnection | 连接低功耗蓝牙设备。 | |
uni.closeBLEConnection | 断开与低功耗蓝牙设备的连接。 | |
plus.bluetooth.closeBLEConnection | 断开与低功耗蓝牙设备的连接。 | |
plus.bluetooth.createBLEConnection | 连接低功耗蓝牙设备。 | |
plus.bluetooth.setBLEMTU | 设置蓝牙最大传输单元。 | |
plus.bluetooth.getBLEDeviceCharacteristics | 获取蓝牙设备某个服务中所有特征值(characteristic)。 | |
plus.bluetooth.getBLEDeviceRSSI | 获取蓝牙设备的信号强度。 | |
plus.bluetooth.getBLEDeviceServices | 获取蓝牙设备所有服务（service）。 | |
plus.bluetooth.notifyBLECharacteristicValueChange | 启用低功耗蓝牙设备特征值变化时的 notify功能，订阅特征值。 | |
plus.bluetooth.onBLECharacteristicValueChange | 监听低功耗蓝牙设备的特征值变化事件。 | |
plus.bluetooth.onBLEConnectionStateChange | 监听低功耗蓝牙连接状态的改变事件。 | |
plus.bluetooth.readBLECharacteristicValu | 读取低功耗蓝牙设备的特征值的二进制数据值。 | |
plus.bluetooth.writeBLECharacteristicValue | 向低功耗蓝牙设备特征值中写入二进制数据。 |
iBeacon
名称 | 功能说明 | 链接 |
uni.onBeaconServiceChange | 监听iBeacon服务状态变化事件。 | |
uni.onBeaconUpdate | 监听iBeacon设备更新事件。 | |
uni.getBeacons | 获取所有已搜索到的iBeacon设备。 | |
uni.startBeaconDiscovery | 开始搜索附近的iBeacon设备。 | |
uni.stopBeaconDiscovery | 停止搜索附近的iBeacon设备。 | |
plus.ibeacon.startBeaconDiscovery | 开始搜索附近的iBeacon设备。 | |
plus.ibeacon.stopBeaconDiscovery | 停止搜索附近的iBeacon设备。 | |
plus.ibeacon.getBeacons | 获取所有已搜索到的iBeacon设备。 | |
plus.ibeacon.onBeaconUpdate | 监听iBeacon设备更新事件。 | |
plus.ibeacon.onBeaconServiceChange | 监听iBeacon服务状态变化事件。 |
生物认证
名称 | 功能说明 | 说明 |
uni.startSoterAuthentication | 开始SOTER生物认证。 | |
uni.checkIsSupportSoterAuthentication | 获取本机支持的SOTER生物认证方式。 | |
uni.checkIsSoterEnrolledInDevice | 获取设备内是否录入如指纹等生物信息的接口。 |
指纹
名称 | 功能说明 | 说明 |
plus.fingerprint.isSupport | 当前设备是否支持指纹识别。 | |
plus.fingerprint.isKeyguardSecure | 当前设备是否设置密码锁屏。 | |
plus.fingerprint.isEnrolledFingerprints | 当前设备是否已经录入指纹。 | |
plus.fingerprint.authenticate | 指纹识别认证。 | |
plus.fingerprint.cancel | 取消指纹识别认证。 |
OAuth
名称 | 功能说明 | 链接 |
plus.oauth.getServices | 获取登录鉴权列表。 |
支付
名称 | 功能说明 | 链接 |
plus.payment.getChannels | 获取支付通道。 | |
plus.payment.request | 请求支付操作。 |
存储
名称 | 功能说明 | 链接 |
plus.storage.clear | 同步清除存储数据。 | |
plus.storage.clearAsync | 异步清除存储数据。 | |
plus.storage.getAllKeys | 同步获取所有键。 | |
plus.storage.getAllKeysAsync | 异步获取所有键。 | |
plus.storage.getLength | 获取存储数据的个数。 | |
plus.storage.getItem | 同步获取存储的键值。 | |
plus.storage.getItemAsync | 异步获取存储的键值。 | |
plus.storage.key | 获取键值对中指定索引值的key值。 | |
plus.storage.setItem | 同步存储键值。 | |
plus.storage.setItemAsync | 异步存储键值。 | |
plus.storage.removeItem | 同步删除键值。 | |
plus.storage.removeItemAsync | 异步删除键值。 |
键盘/按键
名称 | 功能说明 | 链接 |
uni.hideKeyboard | 隐藏软键盘。 | |
uni.onKeyboardHeightChange | 监听键盘高度变化。 | |
uni.offKeyboardHeightChange | 取消监听键盘高度变化事件。 | |
uni.getSelectedTextRange | 在input、textarea等focus之后，获取输入框的光标位置。 | |
plus.key.hideSoftKeybord | 隐藏软键盘。 | |
plus.key.setAssistantType | 设置辅助输入类型。 | |
plus.key.showSoftKeybord | 显示软键盘。 | |
plus.key.addEventListener | 添加按键事件监听器。 | |
plus.key.setVolumeButtonEnabled | 设置音量键是否生效。 | |
plus.key.removeEventListener | 移除按键事件监听器。 |
界面
交互反馈
名称 | 功能说明 | 链接 |
uni.showToast | 显示消息提示框。 | |
uni.hideToast | 隐藏消息提示框。 | |
uni.showLoading | 显示 loading 提示框, 需主动调用 uni.hideLoading才能关闭提示框。 | |
uni.hideLoading | 隐藏loading提示框。 | |
uni.showModal | 显示模态弹窗，可以只有一个确定按钮，也可以同时有确定和取消按钮。类似于一个API整合了 html中：alert、confirm。 | |
uni.showActionSheet | 从底部向上弹出操作菜单。 | |
plus.nativeUI.actionSheet | 弹出系统选择按钮框。 | |
plus.nativeUI.alert | 弹出系统提示对话框。 | |
plus.nativeUI.confirm | 弹出系统确认对话框。 | |
plus.nativeUI.closePreviewImage | 关闭预览图片界面。 | |
plus.nativeUI.closeWaiting | 关闭系统等待对话框。 | |
plus.nativeUI.closeToast | 关闭自动消息的提示消息。 | |
plus.nativeUI.previewImage | 预览图片。 | |
plus.nativeUI.showWaiting | 显示系统等待对话框。 | |
plus.nativeUI.pickDate | 弹出系统日期选择对话框。 | |
plus.nativeUI.pickTime | 弹出系统时间对话框。 | |
plus.nativeUI.prompt | 弹出系统输入对话框。 | |
plus.nativeUI.toast | 显示自动消失的提示消息。 | |
plus.nativeUI.setUIStyle | 设置原生界面样式。 |
设置导航条
名称 | 功能说明 | 链接 |
uni.setNavigationBarTitle | 动态设置当前页面的标题。 | |
uni.setNavigationBarColor | 设置页面导航条颜色。 说明 如果需要进入页面就设置颜色，请延迟执行，防止被框架内设置颜色逻辑覆盖。 |
设置TabBar
名称 | 功能说明 | 链接 |
uni.setTabBarItem | 动态设置TabBar某一项的内容。 | |
uni.setTabBarStyle | 动态设置TabBar的整体样式。 | |
uni.hideTabBar | 隐藏TabBar。 | |
uni.showTabBar | 显示TabBar。 | |
uni.setTabBarBadge | 为TabBar某一项的右上角添加文本。 | |
uni.removeTabBarBadge | 移除TabBar某一项右上角的文本。 | |
uni.showTabBarRedDot | 显示TabBar某一项的右上角的红点。 | |
uni.hideTabBarRedDot | 隐藏TabBar某一项的右上角的红点。 | |
uni.onTabBarMidButtonTap | 监听中间按钮的点击事件。 |
动画
名称 | 功能说明 | 链接 |
uni.createAnimation | 创建一个动画实例animation。调用实例的方法来描述动画。最后通过动画实例的export方法导出动画数据传递给组件的animation属性。 |
滚动
名称 | 功能说明 | 链接 |
uni.pageScrollTo | 将页面滚动到目标位置。 |
窗口
名称 | 功能说明 | 链接 |
uni.onWindowResize | 监听窗口尺寸变化事件。 | |
uni.offWindowResize | 取消监听窗口尺寸变化事件。 |
字体
名称 | 功能说明 | 链接 |
uni.loadFontFace | 动态加载网络字体，文件地址需为下载类型。 | |
uni.upx2px | 将rpx单位值转换成px。 |
下拉刷新
名称 | 功能说明 | 链接 |
uni.startPullDownRefresh | 开始下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。 | |
uni.stopPullDownRefresh | 停止当前页面下拉刷新。 |
节点信息
名称 | 功能说明 | 链接 |
uni.createSelectorQuery | 返回一个SelectorQuery对象实例。可以在这个实例上使用select等方法选择节点，并使用boundingClientRect等方法选择需要查询的信息。 |
节点布局相交状态
名称 | 功能说明 | 链接 |
uni.createIntersectionObserver | 创建并返回一个IntersectionObserver对象实例。 |
媒体查询
名称 | 功能说明 | 链接 |
uni.createMediaQueryObserver | 创建并返回一个MediaQueryObserver对象实例。 |
语言
名称 | 功能说明 | 链接 |
uni.getLocale | 获取当前设置的语言。 | |
uni.setLocale | 设置当前语言。 | |
uni.onLocaleChange | 用于监听应用语言切换。 |
文件
名称 | 功能说明 | 链接 |
uni.saveFile | 保存文件到本地。 | |
uni.getSavedFileList | 获取本地已保存的文件列表。 | |
uni.getSavedFileInfo | 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件。 | |
uni.removeSavedFile | 删除本地存储的文件。 | |
uni.getFileInfo | 获取文件信息。 | |
uni.openDocument | 新开页面打开文档，支持格式：doc、xls、ppt、pdf、docx、xlsx、pptx。 | |
plus.io.requestFileSystem | 请求本地文件系统对象。 | |
plus.io.resolveLocalFileSystemURL | 通过URL参数获取目录对象或文件对象。 | |
plus.io.convertLocalFileSystemURL | 将本地URL路径转换成平台绝对路径。 | |
plus.io.convertAbsoluteFileSystem | 讲评台绝对路径转换成本地URL路径。 | |
plus.io.getAudioInfo | 获取音频信息。 | |
plus.io.getFileInfo | 获取文件信息。 | |
plus.io.getImageInfo | 获取图片信息。 | |
plus.io.getVideoInfo | 获取视频文件信息。 |
下载
名称 | 功能说明 | 链接 |
plus.downloader.createDownload | 新建下载任务。 | |
plus.downloader.enumerate | 枚举下载任务。 | |
plus.downloader.clear | 清除下载任务。 | |
plus.downloader.startAll | 开发所有下载任务。 |
上传
名称 | 功能说明 | 链接 |
plus.uploader.createUpload | 新建上传任务。 | |
plus.uploader.enumerate | 枚举上传任务。 | |
plus.uploader.clear | 清除上传任务。 | |
plus.uploader.startAll | 开发所有上传任务。 |
压缩
名称 | 功能说明 | 链接 |
plus.zip.compress | 压缩生成zip文件。 | |
plus.zip.decompress | 解压缩zip文件。 | |
plus.zip.compressImage | 图片压缩转换。 | |
plus.zip.compressVideo | 视频压缩。 |
绘画
名称 | 功能说明 | 链接 |
uni.createCanvasContext | 创建canvas绘图上下文（指定canvasId）。在自定义组件下，第二个参数传入组件实例this，以操作组件内<canvas/>组件。 | |
uni.canvasToTempFilePath | 把当前画布指定区域的内容导出生成指定大小的图片，并返回文件路径。在自定义组件下，第二个参数传入自定义组件实例，以操作组件内<canvas>组件。 | |
uni.canvasPutImageData | 将像素数据绘制到画布的方法，在自定义组件下，第二个参数传入自定义组件实例this，以操作组件内<canvas>组件。 | |
uni.canvasGetImageData | 返回一个数组，用来描述canvas区域隐含的像素数据，在自定义组件下，第二个参数传入自定义组件实例this，以操作组件内<canvas>组件。 |
数据库
名称 | 功能说明 | 链接 |
plus.sqlite.openDatabase | 打开数据库。 | |
plus.sqlite.isOpenDatabase | 判断数据库是否打开。 | |
plus.sqlite.closeDatabase | 关闭数据库。 | |
plus.sqlite.transaction | 执行事务。 | |
plus.sqlite.executeSql | 执行增删改等操作的SQL语句。 | |
plus.sqlite.selectSql | 执行查询的SQL语句。 |
WebView
名称 | 功能说明 | 链接 |
plus.webview.all | 获取所有WebView窗口 | |
plus.webview.close | 关闭WebView窗口 | |
plus.webview.create | 创建新的WebView窗口 | |
plus.webview.currentWebview | 获取当前窗口的WebviewObject对象 | |
plus.webview.getDisplayWebview | 获取屏幕所有可视的WebView窗口 | |
plus.webview.getWebviewById | 查找指定标识的WebViewObject窗口 | |
plus.webview.getLaunchWebview | 获取应用首页WebviewObject窗口对象 | |
plus.webview.getSecondWebview | 获取应用第二个首页WebviewObject窗口对象 | |
plus.webview.getTopWebview | 获取应用显示栈顶的WebviewObject窗口对象 | |
plus.webview.hide | 隐藏WebView窗口 | |
plus.webview.open | 创建并打开WebView窗口 | |
plus.webview.prefetchURL | 预载网络页面 | |
plus.webview.prefetchURLs | 预载网络页面(多个地址) | |
plus.webview.show | 显示Webview窗口 | |
plus.webview.startAnimation | Webview窗口组合动画 | |
plus.webview.defaultHardwareAccelerated | 获取Webview默认是否开启硬件加速 |
三方服务
获取服务供应商
名称 | 功能说明 | 链接 |
uni.getProvider | 获取服务供应商 |
登录
名称 | 功能说明 | 链接 |
uni.login | uni.login是一个客户端API，统一封装了各个平台的各种常见的登录方式，包括App手机号一键登录、三方登录（微信、微博、QQ、Apple、google、facebook）、各家小程序内置登录。 | |
uni.getUserInfo | 获取用户信息。 | |
uni.preLogin | 预登录。用于App手机号一键登录。 | |
uni.closeAuthView | 关闭一键登录页面。 按照中国移动、中国联通、中国电信等运营商的要求，一键登录必须有界面。可用此API关闭页面 | |
uni.getCheckBoxState | 获取一键登录条款勾选框状态。 | |
uni.getUniverifyManager | 获取全局唯一的一键登录管理器 univerifyManager。 |
语音识别
名称 | 功能说明 | 链接 |
plus.speech.startRecognize | 启动语音识别。 | |
plus.speech.stopRecognize | 停止语音识别。 | |
plus.speech.addEventListener | 监听语音识别时间。 |
分享
名称 | 功能说明 | 链接 |
uni.share | uni-app的App引擎已经封装了微信、QQ、微博的分享SDK，开发者可以直接调用相关功能。 | |
uni.shareWithSystem | 调用系统分享组件发送分享消息，不需要配置分享SDK。 | |
plus.share.sendWithSystem | 调用系统的分享组件。 | |
plus.share.getServices | 获取分享服务。 |
支付
名称 | 功能说明 | 链接 |
uni.requestPayment | 支付。 |
推送
名称 | 功能说明 | 链接 |
uni.getPushClientId | 获取客户端唯一的推送标识。 | |
uni.onPushMessage | 启动监听推送消息事件。 | |
uni.offPushMessage | 关闭推送消息监听事件。 | |
uni.createPushMessage | 创建本地通知栏消息。 | |
plus.push.addEventListener | 添加推送消息时间监听器。 | |
plus.push.clear | 清空所有推送消息。 | |
plus.push.createMessage | 创建本地消息。 | |
plus.push.getAllMessage | 获取所有推送消息。 | |
plus.push.getClientInfo | 获取客户端推送标识信息。 | |
plus.push.getClientInfoAsync | 异步获取客户端推送标识信息。 | |
plus.push.setAutoNotification | 设置程序是否将消息显示在系统消息中心。 | |
plus.push.remove | 删除推送消息。 |
实人认证
名称 | 功能说明 | 链接 |
uni.getFacialRecognitionMetaInfo | 获取实人认证设备信息。 | |
uni.startFacialRecognitionVerify | 实人认证，打开刷脸认证界面。 |
统计
名称 | 功能说明 | 链接 |
plus.statistic.eventTrig | 触发事件。 | |
plus.statistic.eventDuration | 精确持续事件。 |