# 简介
- 该页下的H5-API和APP-SDK的区别在于,H5-API里面的api是移动前端脚手架对APP-SDK的二次封装,里面的方法都挂载到this.$app这个对象上
- 并且H5-API有大约90%的api底层还是调用了APP-SDK，而APP-SDK的能力都是原生外壳提供,也就是只有在YUMP的外壳底座APP中运行时，才存在这些APP-SDK的方法
- 所以要使用H5-API的前提是,使用了本产品的移动前端脚手架,并且运行在YUMP的外壳底座APP中,在运行时才有APP-SDK
# 最佳实践
- 通过产品部下发的云打包账号打出app包,安装到测试手机上
- 通过真机调试方案加载本地工程页面 真机调试
- 把想用的方法示例代码拷贝到vConsole输入,点OK运行试看效果。或者直接在代码中使用示例代码,真机查看效果
# API 列表
# 基础
# 日志打印
| API | 说明 |
|---|---|
| console | 向控制台打印日志信息 |
# 定时器
| API | 说明 |
|---|---|
| setTimeout | 设定一个定时器。在定时到期以后执行注册的回调函数 |
| clearTimeout | 取消由 setTimeout 设置的定时器 |
| setInterval | 设定一个定时器。按照指定的周期（以毫秒计）来执行注册的回调函数 |
| clearInterval | 取消由 setInterval 设置的定时器 |
# 网络
# 发起请求
| API | 说明 |
|---|---|
| request | 发起网络请求 |
| doCancel | 取消网络请求 |
# 路由与页面跳转
| API | 说明 |
|---|---|
| launchH5App | 打开新模块中新页面窗口 |
| navigateTo | 保留当前页面，跳转到应用内的某个页面，使用uni.navigateBack可以返回到原页面 |
| redirectTo | 关闭当前页面，跳转到应用内的某个页面 |
| switchTab | 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 |
| navigateBack | 关闭当前页面，返回上一页面或多级页面 |
| exitApp | 退出当前容器 |
| popWindow | 退到根容器 |
| openWindow | 打开一个新的webview页面（仅用于在线文档显示） |
| getContainerStack | 获取导航栏容器栈信息 |
| getStartupParams | 获取容器启动参数 |
| getAppCustomParams | 获取容器启动业务参数 |
# 数据缓存
| API | 说明 |
|---|---|
| setAPDataStorage | 将数据存储在本地运行态中指定的 key 中，会覆盖掉原来该 key 对应的内容。 |
| getAPDataStorage | 获取存储在本地缓存中指定的 key 中数据 |
| removeRunTimeStorage | 删除存储在本地缓存中指定的 key 中数据。 |
| clearApData | 清除存储在本地缓存中全部数据 |
| setAppData | 将数据存储在本地指定的 key 中，会覆盖掉原来该 key 对应的内容。 |
| getAppData | 获取存储在本地缓存中指定的 key 中数据。 |
| removeAppData | 删除存储在本地缓存中指定的 key 中数据。 |
| clearStorage | 清除所有存储数据 |
# 位置
# 位置信息
| API | 说明 |
|---|---|
| checkGpsOpen | 检查gps服务是否开启。 |
| watchposition | 监听设备位置变化信息 |
| clearwatch | 取消监听设备位置变化信息 |
| clearwatchall | 取消所有监听设备位置变化信息 |
| getLocation | 获取当前的位置信息 |
| openOtherApp | 打开其他App |
| openLocation | App内打开地图 |
# 媒体
# 图片
| API | 说明 |
|---|---|
| takeAlbum | 从系统相册选择文件 |
| takeSingleAlbum | 裁剪图片 （支持拍照裁剪和相册选图裁剪） |
| imageBase64 | 图片转Base64字符串 |
| pickSingleImageWithEdit | 单选并编辑图片 |
| previewImage | 预览图片 |
| saveImage | 保存图片到相册 |
# 相机组件控制
| API | 说明 |
|---|---|
| takePicture | 调用拍照 |
| takeVideo | 调用录制视频 |
| getCamera | 获取摄像头管理对象 |
# 音频录制与播放
| API | 说明 |
|---|---|
| createRecorder | 创建当前设备的录音对象 |
| start | 开始音频录制 |
| pause | 暂停音频录制 |
| resume | 恢复音频录制 |
| stop | 结束音频录制 |
| getAudioInfo | 根据录音批次号获取录音信息 |
| createPlayer | 创建音频播放对象 |
| start | 开始音频播放 |
| pause | 暂停音频播放 |
| resume | 恢复音频播放 |
| stop | 结束音频播放 |
# 设备
# 系统信息
| API | 说明 |
|---|---|
| getSystemInfo | 获取系统信息 |
| getBuild | 获取版本信息 |
| getAppversion | 获取版本号 |
| getH5OffPkgsVersion | 获取本地离线包的版本号 |
| getUUID | 获取UUID |
| getVID | 获取VID |
| getGUID | 获取GUID |
| getLauncherPram | 获取app启动参数 |
| setClipboardData | 设置剪切板内容 |
| getClipboardData | 获取剪切板内容 |
| clearClipboardData | 移除剪切板内容 |
| openNativeSetting | 跳转到设置中心 |
| capture | 截屏 |
| setBadgeNumber | 设置应用桌面小红点数量 |
| getBadgeNumber | 获取应用桌面小红点数量 |
| playSystemVoice | 震动或播放系统音效 |
| setScreenBrightness | 设置屏幕亮度 |
| getScreenBrightness | 获取屏幕亮度 |
| allowScreenShot | 允许系统截屏 |
| disableScreenShot | 禁止系统截屏 |
| getOrientation | 获取应用横竖屏状态 |
| getSafeAreaInsets | 获取安全区域信息 |
| getWifiOpenStatus | 获取应用的wifi开启状态 |
| setKeepScreenOn | 设置是否保持常亮状态 |
| onUserCaptureScreen | 监听用户主动截屏事件 |
| offUserCaptureScreen | 移除截屏监听事件 |
| scanCode | 二维码扫码 |
| createQRCodeImage | 生成二维码 |
| showSoftKeybord | 显示系统键盘,IOS不支持 |
| hideSoftKeybord | 隐藏系统键盘 |
| onKeyboardHeightChange | 监听系统键盘高度 |
| offKeyboardHeightChange | 注销系统键盘高度的监听 |
| showPwdkey | 显示安全键盘 |
| hidePwdkey | 隐藏密码键盘 |
| sendWithSystem | 分享到微信 |
| getshareservices | 获取分享服务 |
| aes | aes加解密 |
# 拨打电话
| API | 说明 |
|---|---|
| makePhoneCall | 调用拨打电话功能 |
| pickAddressBook | 选取手机通讯录联系人信息 |
| getAddressBook | 获取系统通讯录 |
# 网络状态
| API | 说明 |
|---|---|
| getNetworkType | 获取网络类型。 |
| getIpAddress | 获取本地网络ip |
# 多语言
| API | 说明 |
|---|---|
| setAppLanguage | 设置app的语言 |
| getAppLanguage | 获取app的语言 |
| getSupportLanguageList | 获取app支持的语言 |
# webview
| API | 说明 |
|---|---|
| createWebview | 创建webView |
| openWebview | 创建并显示webView |
| showWebview | 显示webView |
| pushNewWebview | 推入新的webview |
| closeWebview | 关闭webview |
| reloadWebview | 重新加载页面 |
| getWebviewById | 根据id获取webview对象 |
| getAllWebview | 获取所有webview对象 |
| closeSelfWebview | 关闭当前webview |
| onWebview | 注册事件监听 |
| emitWebview | 触发事件 |
| offWebview | 移除事件监听 |
# 文件管理
| API | 说明 |
|---|---|
| upload | 文件上传 |
| pause | 文件上传暂停 |
| resume | 文件上传恢复 |
| uploadEnumerate | 文件上传查询 |
| abort | 文件上传取消 |
| uploadClear | 清除上传任务 |
| download | 文件下载 |
| pause | 文件下载暂停 |
| resume | 文件下载恢复 |
| downloadEnumerate | 文件下载查询 |
| abort | 文件下载取消 |
| downloadClear | 清除下载任务 |
| convertLocalFileSystemURL | 本地扩展相对路径转换成平台绝对路径 |
| convertAbsoluteFileSystem | 平台绝对路径转换成本地扩展相对路径 |
| requestFileSystem | 请求本地扩展文件系统 |
| resolveLocalFileSystemURL | 快速获取指定的目录或文件操作对象 |
| moveTo | 移动本地文件 |
| copyTo | 复制本地文件 |
| remove | 删除本地文件 |
| getMetadata | 获取目录/文件的属性 |
| getFileListMetadata | 获取目录的属性 |
| getFileDigestInfo | 获取文件摘要信息 |
| getDirectory | 创建子目录 |
| getFile | 创建文件 |
| compress | 压缩生成Zip文件 |
| decompress | 解压缩Zip文件 |
| compressImage | 图片压缩转换 |
# 通知中心
| API | 说明 |
|---|---|
| sendSMS | 发送短信 |
| createMessage | 创建本地消息 |
| getAllMessage | 获取所有消息 |
| removeMessage | 删除指定消息 |
| clearMessage | 清除通知中心的消息 |
| getClientInfo | 获取客户端推送标识信息 |
| setAutoNotification | 设置程序是否将消息显示在系统消息中心 |
| setAlias | 绑定推送别名 |
| deleteAlias | 删除推送别名 |
# 原生路由
| API | 说明 |
|---|---|
| openNativePage | 打开一个原生页面 |
# 手势管理
| API | 说明 |
|---|---|
| openUnlock | 打开手势页面 |
| currentGesture | 获取当前用户手势信息 |
| clearGestureErrorTimes | 重置当前用户手势输入错误次数 |
| closeUnlock | 关闭手势页面 |
| clearGestureInfo | 删除当前用户的手势信息 |
# 数据中心
| API | 说明 |
|---|---|
| setAPDataStorage | 保存数据 |
| getAPDataStorage | 获取数据 |
| removeAPDataStorage | 移除数据 |
| meteringCacheRange | 设置文件缓存目录 |
| calculateCache | 获取文件缓存大小 |
| clearCache | 清除文件缓存 |
# 生物识别
| API | 说明 |
|---|---|
| getDeviceBiometrics | 获取当前设备支持的生物识别类型 |
| fingerPrintVerification | 进行生物识别（指纹/面容）验证 |
| updateTouchIdInfo | 更新本的生物识别信息 |
# 事件监听
| API | 说明 |
|---|---|
| APPEnterForeground | app进入前台监听触发。 |
| APPEnterBackground | app进入后台时触发监听。 |
| containerAppear | app内页面切换到当前页面显示时，触发监听。 |
| containerDisappear | app内离开当前页面时，触发监听。 |
| pageOnBackResume | 页面返回时，触发监听。 |
# 界面
# 交互反馈
| API | 说明 |
|---|---|
| showLoading | 显示加载提示框 |
| hideLoading | 隐藏提示框 |
| sdktoast | 调用外壳弱提示框 |
| openDoc | 文档预览 |
| openFile | 调用第三方程序打开指定的文件 |
| openWeb | 使用内置Webview窗口打开URL |
| openURL | 调用第三方程序打开指定的URL，（iOS使用safari打开） |
| appFinish | 退出app |
| setMenuBadge | 设置右上角按钮badge |
| actionSheet | 从页面底部弹出的选择框 |
| existApp | 是否安装某app |
# 设置导航条
| API | 说明 |
|---|---|
| interceptBackEvent | 开启导航栏返回按钮拦截 |
| releaseInterceptBackEvent | 释放导航栏返回按钮拦截 |
# 设置TabBar
| API | 说明 |
|---|---|
| setTitle | 设置导航栏标题 |
| setTitleBarColor | 设置导航栏背景颜色 |
| setBarBottomLineColor | 设置导航栏底部线条颜色 |
| setTitleVisible | 显示/隐藏导航栏 |
| setOptionMenu | 设置导航栏右上角按钮 |
| hideOptionMenu | 隐藏导航栏右上角按钮 |
| showOptionMenu | 显示导航栏右上角按钮 |
| showFloatMenu | 显示气泡菜单 |
| getStatusBarHeight | 获取状态栏高度 |
# 设置stateBar
| API | 说明 |
|---|---|
| setStatusBarStyle | 设置顶部状态栏样式(电磁条部分) |
| getStatusBarStyle | 获取顶部状态栏样式(电磁条部分) |
# 日历
| API | 说明 |
|---|---|
| createAccount | 创建日历 |
| createAlarm | 创建事件 |
# 水印
| API | 说明 |
|---|---|
| addWaterMark | 创建日历 |
| removeWaterMark | 创建事件 |