Api总览
# 界面
页面跳转
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GotoUrl | 页面跳转 | Android 21+ |
| GoBack | 页面返回 | Android 21+ |
| GotoMain | 跳转主界面 | Android 21+ |
弹窗
| API名称 | 说明 | 支持版本 |
|---|---|---|
| ShowMsg | 显示弹窗Message | Android 21+ |
| ShowDialog | 显示带操作事件弹窗 | Android 21+ |
| ShowLoading | 显示加载中 | Android 21+ |
| HidLoading | 取消加载中 | Android 21+ |
| PopupShow | 普通弹窗 | Android 21+ |
| RefreshDialog | 刷新页面弹窗 | Android 21+ |
状态栏
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SetStatusBarStyle | 设置顶部状态栏黑白 | Android 21+ |
| SetStatusBarBgColor | 设置头部状态栏背景色 | Android 21+ |
| GetStatusBarHeight | 获取状态栏高度 | Android 21+ |
导航栏
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SetTitle | 设置顶部Title文字 | Android 21+ |
| SetRightButtonTitle | 修改title右侧文字 | Android 21+ |
Tabbar
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SetBadgeValue | 信息角标绘制 | Android 21+ |
| ClearBadgeValue | 信息角标绘制 | Android 21+ |
其它页面
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GoToVideo | 进入视频播放页面 | Android 21+ |
| GoToMap | 进入高德地图页面 | Android 21+ |
打开侧边栏
| API名称 | 说明 | 支持版本 |
|---|---|---|
| Drawer | 打开侧边栏页面 | Android 21+ |
| DrawerBack | 关闭侧边栏页面 | Android 21+ |
页面更新
| API名称 | 说明 | 支持版本 |
|---|---|---|
| PageCheck | 页面立即更新 | Android 21+ |
悬浮窗
| API名称 | 说明 | 支持版本 |
|---|---|---|
| FloatingWindowData | 当前页面加入浮窗权限 | Android 21+ |
软键盘
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SoftKeyBoardUp | 软键盘顶起布局 | Android 21+ |
# 开放接口
分享
| API名称 | 说明 | 支持版本 |
|---|---|---|
| ShareTimelineImage | 分享到微信朋友圈 | Android 21+ |
| ShareAppMessageImage | 分享到微信好友 | Android 21+ |
| Base64ImageShareWechatSession | base64图片分享微信好友 | Android 21+ |
| Base64ImageShareWechatTimeline | base64图片分享微信朋友圈 | Android 21+ |
支付
| API名称 | 说明 | 支持版本 |
|---|---|---|
| Alipay | 支付宝支付 | Android 21+ |
客服
| API名称 | 说明 | 支持版本 |
|---|---|---|
| OnlineService | 美洽客服系统 | Android 21+ |
拉起外部App
| API名称 | 说明 | 支持版本 |
|---|---|---|
| OpenOtherApp | 拉起外部App | Android 21+ |
| OpenWechatMiniProgram | 拉起微信小程序 | Android 21+ |
本地服务
| API名称 | 说明 | 支持版本 |
|---|---|---|
| StartHttpServer | 启动本地服务 | Android 21+ |
| StopHttpServer | 关闭本地服务 | Android 21+ |
# 媒体
相机
| API名称 | 说明 | 支持版本 |
|---|---|---|
| UploadPhoto | 选择拍照或者本地 | Android 21+ |
图片
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SaveToSd | 网络图片保存本地 | Android 21+ |
| CachePicture | 图片缓存至本地 | Android 21+ |
| PhotoBrowser | 大图浏览 | Android 21+ |
| SaveBase64ImageToSd | Base64转图片并保存本地相册 | Android 21+ |
音乐
| API名称 | 说明 | 支持版本 |
|---|---|---|
| PlayMusic | 音乐是否在播放 | Android 21+ |
# 位置
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetLocation | 获取当前位置 | Android 21+ |
# 设备
拨打电话
| API名称 | 说明 | 支持版本 |
|---|---|---|
| PhoneCall | 拨打电话 | Android 21+ |
扫码
| API名称 | 说明 | 支持版本 |
|---|---|---|
| ScanQRCode | 二维码(条形码)识别 | Android 24+ |
| QRCodeBase64 | 扫描Base64转图片后的二维码 | Android 24+ |
剪贴板
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetClipboardContent | 获取剪贴板信息 | Android 21+ |
| ClearClipboard | 清除剪贴板信息 | Android 21+ |
陀螺仪
| API名称 | 说明 | 支持版本 |
|---|---|---|
| OpenGyro | 陀螺仪数据 | Android 21+ |
| CloseGyro | 关闭陀螺仪 | Android 21+ |
屏幕亮度
| API名称 | 说明 | 支持版本 |
|---|---|---|
| Brightness | 修改屏幕亮度 | Android 21+ |
| GetBrightness | 获取屏幕亮度 | Android 21+ |
音量
| API名称 | 说明 | 支持版本 |
|---|---|---|
| VolumeControl | 修改音量 | Android 21+ |
| GetVolume | 获取音量 | Android 21+ |
网络
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetNetworkConnectionType | 获取网络类型 | Android 21+ |
获取设备信息
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetDeviceInfo | 获取设备信息 | Android 21+ |
生物认证
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetBiometricRecognition | 面容指纹认证 | Android 29+ |
OCR
| API名称 | 说明 | 支持版本 |
|---|---|---|
| OCRIdCard | OCR识别身份证 | Android 21+ |
| OCRBankCard | 调用摄像头对银行卡进行智能识别 | Android 21+ |
日历
| API名称 | 说明 | 支持版本 |
|---|---|---|
| ScheduleReminder | 写入日历提醒 | Android 21+ |
权限设置页面
| API名称 | 说明 | 支持版本 |
|---|---|---|
| SettingApns | 跳转权限设置页面 | Android 21+ |
# 数据存储
| API名称 | 说明 | 支持版本 |
|---|---|---|
| PutCookieInfo | 本地存值 | Android 21+ |
| GetCookieInfo | 本地取值 | Android 21+ |
| ClearAppCache | 清除缓存用户的数据 | Android 21+ |
| CacheSize | 获得缓存文件夹当前大小 | Android 21+ |
| WriteLog | 文本内容写入本地 | Android 21+ |
# App信息
| API名称 | 说明 | 支持版本 |
|---|---|---|
| GetAppVersion | 获取应用版本名 | Android 21+ |
| GetAppIconsPath | 应用图标列表 | Android 21+ |
| ReplaceAppIcon | 动态更换APP图标 | Android 21+ |
# 小程序
| API名称 | 说明 | 支持版本 |
|---|---|---|
| JumpMiniApp | 进入小程序 | Android 21+ |
| MiniAppLocalList | 本地已加载小程序列表 | Android 21+ |
| MiniAppDelete | 删除所有小程序数据 | Android 21+ |
# 下载
| API名称 | 说明 | 支持版本 |
|---|---|---|
| DownloadFiles | 后台下载 | Android 21+ |
| GetDownloadFileProgress | 获取下载进度 | Android 21+ |
| DownloadFileCancel | 取消下载 | Android 21+ |
| DownloadFileDelete | 删除已下载文件 | Android 21+ |
| GetFinishDownloadPaths | 获取已完成保存路径 | Android 21+ |
# 半屏小程序
| API名称 | 说明 | 支持版本 |
|---|---|---|
| JumpHalfScreenApp | 半屏小程序 | Android 21+ |
# 阿里云推送
| API名称 | 说明 | 支持版本 |
|---|---|---|
| BindCloudChannel | 绑定阿里云推送账号 | Android 21+ |
| UnbindCloudChannel | 解除绑定云推送账号 | Android 21+ |
| IsOpenPushSound | 是否开启推送音效 | Android 21+ |
| getApnsAuthorizationStatus | 获取用户推送通知授权状态 | Android 21+ |
| InitCloudChannel | 初始化云推送通道 | Android 21+ |
# 自动登录
| API名称 | 说明 | 支持版本 |
|---|---|---|
| AutoLogin | 自动登录 | Android 21+ |