mirror of
https://github.com/ialley-workshop-open/uni-halo.git
synced 2026-09-13 00:50:40 +08:00
小莫唐尼
8.1 KiB
8.1 KiB
UniApp API 参考文档
本文档提供 uni-app 所有 API 的完整参考信息。
API 分类索引
1. 网络请求（Network）
- uni.request - 发起网络请求
- uni.uploadFile - 上传文件
- uni.downloadFile - 下载文件
- uni.connectSocket - 创建 WebSocket 连接
- uni.onSocketOpen - 监听 WebSocket 连接打开事件
- uni.onSocketError - 监听 WebSocket 错误事件
- uni.sendSocketMessage - 通过 WebSocket 发送数据
- uni.onSocketMessage - 监听 WebSocket 接受到服务器的消息事件
- uni.closeSocket - 关闭 WebSocket 连接
- uni.onSocketClose - 监听 WebSocket 连接关闭事件
2. 数据存储（Storage）
- uni.setStorage - 将数据存储在本地缓存中指定的 key 中
- uni.setStorageSync - 同步将数据存储在本地缓存中指定的 key 中
- uni.getStorage - 从本地缓存中异步获取指定 key 的内容
- uni.getStorageSync - 从本地缓存中同步获取指定 key 的内容
- uni.getStorageInfo - 异步获取当前 storage 的相关信息
- uni.getStorageInfoSync - 同步获取当前 storage 的相关信息
- uni.removeStorage - 从本地缓存中异步移除指定 key
- uni.removeStorageSync - 从本地缓存中同步移除指定 key
- uni.clearStorage - 清理本地数据缓存
- uni.clearStorageSync - 同步清理本地数据缓存
3. 设备信息（Device）
- uni.getSystemInfo - 获取系统信息
- uni.getSystemInfoSync - 同步获取系统信息
- uni.getNetworkType - 获取网络类型
- uni.onNetworkStatusChange - 监听网络状态变化
- uni.getBatteryInfo - 获取设备电量信息
- uni.getBatteryInfoSync - 同步获取设备电量信息
- uni.setScreenBrightness - 设置屏幕亮度
- uni.getScreenBrightness - 获取屏幕亮度
- uni.setKeepScreenOn - 设置是否保持屏幕常亮
4. 界面交互（UI）
- uni.showToast - 显示消息提示框
- uni.showLoading - 显示加载提示框
- uni.hideToast - 隐藏消息提示框
- uni.hideLoading - 隐藏加载提示框
- uni.showModal - 显示模态弹窗
- uni.showActionSheet - 显示操作菜单
- uni.setNavigationBarTitle - 设置当前页面标题
- uni.setNavigationBarColor - 设置页面导航栏颜色
- uni.showNavigationBarLoading - 显示导航栏加载动画
- uni.hideNavigationBarLoading - 隐藏导航栏加载动画
- uni.setTabBarBadge - 为 tabBar 某一项的右上角添加文本
- uni.removeTabBarBadge - 移除 tabBar 某一项右上角的文本
- uni.showTabBarRedDot - 显示 tabBar 某一项的右上角的红点
- uni.hideTabBarRedDot - 隐藏 tabBar 某一项的右上角的红点
- uni.setTabBarStyle - 动态设置 tabBar 的整体样式
- uni.setTabBarItem - 动态设置 tabBar 某一项的内容
5. 位置服务（Location）
- uni.getLocation - 获取当前地理位置
- uni.openLocation - 使用微信内置地图查看位置
- uni.chooseLocation - 打开地图选择位置
6. 媒体处理（Media）
- uni.chooseImage - 从本地相册选择图片或使用相机拍照
- uni.previewImage - 预览图片
- uni.getImageInfo - 获取图片信息
- uni.saveImageToPhotosAlbum - 保存图片到系统相册
- uni.chooseVideo - 从本地相册选择视频或使用相机拍摄视频
- uni.saveVideoToPhotosAlbum - 保存视频到系统相册
- uni.chooseMedia - 拍摄或从手机相册中选择图片或视频
- uni.chooseFile - 从本地选择文件
7. 页面路由（Navigation）
- uni.navigateTo - 保留当前页面，跳转到应用内的某个页面
- uni.redirectTo - 关闭当前页面，跳转到应用内的某个页面
- uni.reLaunch - 关闭所有页面，打开到应用内的某个页面
- uni.switchTab - 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
- uni.navigateBack - 关闭当前页面，返回上一页面或多级页面
8. 文件操作（File）
- uni.saveFile - 保存文件到本地
- uni.getFileInfo - 获取文件信息
- uni.getSavedFileList - 获取已保存的文件列表
- uni.getSavedFileInfo - 获取已保存的文件信息
- uni.removeSavedFile - 删除已保存的文件
9. 支付（Payment）
- uni.requestPayment - 发起支付
10. 分享（Share）
- uni.share - 分享内容
11. 其他 API（Other）
- uni.canIUse - 判断应用的版本是否支持某个 API
- uni.getProvider - 获取服务供应商
- uni.login - 登录
- uni.getUserInfo - 获取用户信息
- uni.checkSession - 检查登录状态是否过期
- uni.authorize - 提前向用户发起授权请求
- uni.openSetting - 调起客户端小程序设置页面
- uni.getSetting - 获取用户的当前设置
API 调用规范
回调函数
uni-app API 支持两种调用方式：
- 回调函数方式：
uni.request({
url: 'https://api.example.com/data',
success: (res) => {
console.log(res.data)
},
fail: (err) => {
console.error(err)
}
})
- Promise 方式（部分 API 支持）：
uni.request({
url: 'https://api.example.com/data'
}).then(res => {
console.log(res.data)
}).catch(err => {
console.error(err)
})
同步 API
部分 API 提供同步版本（以 Sync 结尾），如：
uni.getStorageSync()- 同步获取存储uni.setStorageSync()- 同步设置存储uni.getSystemInfoSync()- 同步获取系统信息
平台兼容性
每个 API 的详细平台支持情况见对应 API 的文档。使用前请检查平台兼容性，必要时使用条件编译：
// #ifdef MP-WEIXIN
uni.requestPayment({
// 微信小程序支付
})
// #endif
// #ifdef APP-PLUS
uni.requestPayment({
// App 支付
})
// #endif