框架提供丰富的 API，可以方便的调起客户端提供的能力，如获取用户信息，本地存储，支付功能等。

JS API命名与小程序相同。各端受自身限制，可能某些API无法使用，具体见每个API的兼容性说明。

除了uni-app框架内置的跨端API，各端自己的特色API也可通过条件编译自由使用。

各端特色API规范参考各端的开发文档。其中App端的JS API参考html5plus.org；uni-app也支持通过扩展原生插件来丰富App端的开发能力，具体参考插件开发文档

说明

• uni.on 开头的 API 是监听某个事件发生的 API 接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数。
• 如未特殊约定，其他 API 接口都接受一个 OBJECT 作为参数。
• OBJECT 中可以指定 success，fail，complete 来接收接口调用结果。
• 平台差异说明若无特殊说明，则表示所有平台均支持。

Promise 封装

uni-app 对部分 API 进行了 Promise 封装，返回数据的第一个参数是错误对象，第二个参数是返回数据。

详细策略如下：

• 异步的方法，如果不传入 success、fail、complete 等 callback 参数，将以 Promise 返回数据。例如：uni.getImageInfo()
• 异步的方法且有返回对象，如果希望获取返回对象，必须至少传入一项 success、fail、complete 等 callback 参数。例如：uni.connectSocket()
• 同步的方法（即以 sync 结束），不封装 Promise。例如：uni.getSystemInfoSync()
• 以 create 开头的方法，不封装 Promise。例如：uni.createMapContext()
• 以 manager 结束的方法，不封装 Promise。例如：uni.getBackgroundAudioManager()使用示例：

// 默认方式
uni.request({
    url: 'https://www.example.com/request',
    success: (res) => {
        console.log(res.data);
    }
});
// Promise
uni.request({
        url: 'https://www.example.com/request'
    })
    .then(data => {//data为一个数组，数组第一项为错误信息，第二项为返回数据
        var [error, res]  = data;
        console.log(res.data);
    })
// Await
function async request () {
    var [error, res] = await uni.request({
        url: 'https://www.example.com/request'
    });
    console.log(res.data);
}

API 列表

网络

发起请求

上传、下载

WebSocket

SocketTask

媒体

图片

录音管理

背景音频播放管理

音频组件管理

视频

相机组件管理

直播组件管理

文件

数据缓存

位置

获取位置

查看位置

地图组件控制

设备

系统信息

内存

网络状态

加速度计

罗盘

陀螺仪

拨打电话

扫码

剪切板

屏幕亮度

用户截屏事件

振动

手机联系人

蓝牙

低耗蓝牙

iBeacon

界面

交互反馈

设置导航条

设置TabBar

背景

动画

滚动

绘画

下拉刷新

节点信息

节点布局相交状态

路由

第三方服务

平台扩展

其他

授权

设置

收货地址

获取发票抬头

小程序跳转

模板消息

小程序更新

调试

获取第三方平台数据

发现错误？想参与编辑？在 GitHub 上编辑此页面！