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