uni-app：uni-app是使用Vue语法开发小程序，H5，App的统一框架

`uni-app`的js API由标准ECMAScript的js API 和 uni 扩展 API 这两部分组成。 标准ecmascript的API非常多，本文档没有必要列全，仅以console、settimeout为例做简要说明。扩展 API 命名与小程序相同。 ## 标准js和浏览器js的区别 `uni-app`的js代码，h5端运行于浏览器中。非h5端，Android平台运行在v8引擎中，iOS平台运行在iOS自带的jscore引擎中。 非H5端，虽然不支持window、document、navigator等浏览器的js API，但也支持标准ECMAScript。 开发者不要把浏览器里的js等价于标准js。 ECMAScript由Ecma国际管理，是基础js语法。浏览器基于标准js扩充了window、document等js API；Node.js基于标准js扩充了fs等模块；小程序也基于标准js扩展了各种wx.xx、my.xx、swan.xx的API。 所以uni-app的非H5端，一样支持标准js，支持if、for等语法，支持字符串、数组、时间等变量及各种处理方法。仅仅是不支持浏览器专用对象。 ## 各端特色API调用 除了uni-app框架内置的跨端API，各端自己的特色API也可通过[条件编译](https://uniapp.dcloud.io/platform)自由使用。 各端特色API规范参考各端的开发文档。其中App端的JS API参考[html5plus.org](https://www.html5plus.org/doc/h5p.html)；uni-app也支持通过扩展原生插件来丰富App端的开发能力，具体参考[插件开发文档](http://ask.dcloud.net.cn/article/35408) 各平台的API新增，不需要uni-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() 使用示例： ```js // 默认方式 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 async function request () { var [error, res] = await uni.request({ url: 'https://www.example.com/request' }); console.log(res.data); } ``` ### API 列表 #### 网络 ##### 发起请求 |API|说明| |:-|:-| |[uni.request](api/request/request?id=request)|发起网络请求| ##### 上传、下载 |API|说明| |:-|:-| |[uni.uploadFile](api/request/network-file?id=uploadfile)|上传文件| |[uni.downloadFile](api/request/network-file?id=downloadfile)|下载文件| ##### WebSocket |API|说明| |:-|:-| |[uni.connectSocket](api/request/websocket?id=connectsocket)|创建 WebSocket 连接| |[uni.onSocketOpen](api/request/websocket?id=onsocketopen)|监听 WebSocket 打开| |[uni.onSocketError](api/request/websocket?id=onsocketerror)|监听 WebSocket 错误| |[uni.sendSocketMessage](api/request/websocket?id=sendsocketmessage)|发送 WebSocket 消息| |[uni.onSocketMessage](api/request/websocket?id=onsocketmessage)|接受 WebSocket 消息| |[uni.closeSocket](api/request/websocket?id=closesocket)|关闭 WebSocket 连接| |[uni.onSocketClose](api/request/websocket?id=onsocketclose)|监听 WebSocket 关闭| ##### SocketTask |API|说明| |---|---| |[SocketTask.send](/api/request/socket-task?id=sockettasksend) |通过 WebSocket 连接发送数据 | |[SocketTask.close](/api/request/socket-task?id=sockettaskclose) |关闭 WebSocket 连接 | |[SocketTask.onOpen](/api/request/socket-task?id=sockettaskonopen) |监听 WebSocket 连接打开事件 | |[SocketTask.onClose](/api/request/socket-task?id=sockettaskonclose) |监听 WebSocket 连接关闭事件 | |[SocketTask.onError](/api/request/socket-task?id=sockettaskonerror) |监听 WebSocket 错误事件 | |[SocketTask.onMessage](/api/request/socket-task?id=sockettaskonmessage) |监听 WebSocket 接受到服务器的消息事件 | #### 媒体 ##### 图片 |API|说明| |:-|:-| |[uni.chooseImage](api/media/image?id=chooseimage)|从相册选择图片，或者拍照| |[uni.previewImage](api/media/image?id=previewimage)|预览图片| |[uni.getImageInfo](api/media/image?id=getimageinfo)|获取图片信息| |[uni.saveImageToPhotosAlbum](api/media/image?id=saveimagetophotosalbum)|保存图片到系统相册| ##### 文件 |API|说明| |:-|:-| |[uni.chooseFile](api/media/file?id=chooseFile)|从本地选择文件| ##### 录音管理 |API|说明| |:-|:-| |[uni.getRecorderManager](api/media/record-manager)|录音管理| ##### 背景音频播放管理 |API|说明| |:-|:-| |[uni.getBackgroundAudioManager](api/media/background-audio-manager)|背景音频播放管理| ##### 音频组件管理 |API|说明| |:-|:-| |[uni.createInnerAudioContext](api/media/audio-context)|音频组件管理| ##### 视频 |API|说明| |:-|:-| |[uni.chooseVideo](api/media/video?id=choosevideo)|从相册选择视频，或者拍摄| |[uni.chooseMedia](api/media/video?id=choosemedia)|拍摄或从手机相册中选择图片或视频。| |[uni.saveVideoToPhotosAlbum](api/media/video?id=savevideotophotosalbum)|保存视频到系统相册| |[uni.createVideoContext](/api/media/video-context?id=createvideocontext)|视频组件管理| ##### 相机组件管理 |API|说明| |:-|:-| |[uni.createCameraContext](api/media/camera-context.md)|相机组件管理| ##### 直播组件管理 |API|说明| |:-|:-| |[uni.createLivePlayerContext](api/media/live-player-context.md)|直播组件管理| #### 文件 |API|说明| |:-|:-| |[uni.saveFile](api/file/file?id=savefile)|保存文件| |[uni.getSavedFileList](api/file/file?id=getsavedfilelist)|获取已保存的文件列表| |[uni.getSavedFileInfo](api/file/file?id=getsavedfileinfo)|获取已保存的文件信息| |[uni.removeSavedFile](api/file/file?id=removesavedfile)|删除已保存的文件信息| |[uni.getFileInfo](/api/file/file?id=getfileinfo)|获取文件信息| |[uni.openDocument](api/file/file?id=opendocument)|打开文件| #### 数据缓存 |API|说明| |:-|:-| |[uni.getStorage](api/storage/storage?id=setstorage)|获取本地数据缓存| |[uni.getStorageSync](api/storage/storage?id=setstoragesync)|获取本地数据缓存| |[uni.setStorage](api/storage/storage?id=getstorage)|设置本地数据缓存| |[uni.setStorageSync](api/storage/storage?id=getstoragesync)|设置本地数据缓存| |[uni.getStorageInfo](api/storage/storage?id=getstorageinfo)|获取本地缓存的相关信息| |[uni.getStorageInfoSync](api/storage/storage?id=getstorageinfosync)|获取本地缓存的相关信息| |[uni.removeStorage](api/storage/storage?id=removestorage)|删除本地缓存内容| |[uni.removeStorageSync](api/storage/storage?id=removestoragesync)|删除本地缓存内容| |[uni.clearStorage](api/storage/storage?id=clearstorage)|清理本地数据缓存| |[uni.clearSt