touchui-api

API

以小程序API方式调用h5+API

---

开发进度

开放接口

• 微信登陆
• 获取用户信息
• 发起支付

界面

暂不处理

设备

• 获取手机网络状态
• 获取手机系统信息
  • 异步获取手机系统信息
  • 同步获取手机系统信息
• 监听重力感应数据
• 监听罗盘数据
• 打电话
• 扫码

网络

• 发起一个请求
• WebSocket
• 上传文件
• 下载文件

媒体

• 图片
  • 选择图片
  • 预览图片
  • [x] 获取图片信息
  • 保存图片到系统相册
• 录音
  • 开始录音
  • 停止录音
  • 播放音频
  • 暂停播放音频
  • 停止播放音频
• 背景音频
  • 获取后台音乐播放状态
  • 使用后台播放器播放音乐
  • 暂停播放音乐
  • 控制音乐播放进度
  • 停止播放音乐
  • 监听音乐播放
  • 监听音乐暂停
  • 监听音乐停止
  • 获取全局唯一的背景音频管理器
• 文件
  • 保存文件到本地
  • 获取本地已保存的文件列表
  • 获取本地文件的文件信息
  • 删除本地存储的文件
  • 新开页面打开文档
• 视频
  • 拍摄视频或从手机相册中选视频
  • 保存视频到系统相册

位置

• 获取当前位置
• 使用原生地图查看位置
• 使用原生地图选择位置
• 地图组件控制

数据缓存

• storage

其他

剪贴板

• 设置系统剪贴板的内容
• 获取系统剪贴板内容

屏幕亮度

• 设置屏幕亮度
• 获取屏幕亮度
• 设置是否保持常亮状态

震动

• 使手机发生较长时间的振动
• 使手机发生较短时间的振动

手机联系人

• 添加联系人信息

截屏

• 监听截屏事件

蓝牙

• 蓝牙

拓展接口

• 将 ArrayBuffer 数据转成 Base64 字符串
• 将 ArrayBuffer 数据转成 Base64 字符串

使用文档

使用浏览器打开网址

api.openBrowser(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
url	String	是	要浏览的页面地址
system	Boolean	否	是否使用系统浏览器打开（默认为：false，使用内置浏览器打开）
backgroundColor	String	否	标题栏背景颜色
color	String	否	标题栏文字颜色
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

扫码

api.scanCode(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
onlyFromCamera	Boolean	否	是否只能从相机扫码，不允许从相册选择图片
backgroundColor	String	否	标题栏背景颜色
color	String	否	标题栏文字颜色
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

判断指纹硬件是否可用

api.canUseTouchID(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

使用指纹进行验证

api.useTouchID(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

分享到第三方应用

api.share(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
target	String	是	要分享到的应用（weixin_timeline、weixin_message、weibo、qq）
type	String	否	分享类型（link、text、image 默认为link）
title	String	否	分享标题（分享类型需为link）
content	String	否	分享内容(分享类型为text时必选)
icon	String	否	分享缩略图（分享类型需为link、图片大小需要小于30Kb）
href	String	否	分享链接（分享类型需为link）
pictures	Array	否	分享图片（分享类型需为image、图片地址不支持网络路径、部分平台仅支持分享一张图片）
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

选择联系人电话号码

api.pickPhoneNumber(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回电话号码 phoneNumber
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

监听状态栏点击事件（仅支持iOS）

api.onStatusbarTap(CALLBACK)

CALLBACK返回参数：

无

监听返回按钮点击事件

api.onBackButtonClick(CALLBACK)

CALLBACK返回参数：

无

取消监听返回按钮点击

api.offBackButtonClick(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
listener	Function	是	要移除的事件监听回调函数
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

获取页面的侧滑手势是否开启（仅支持iOS）

api.getPagePopGesture(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调,返回手势是否开启（openPagePopGesture）
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置页面的侧滑关闭手势（仅支持iOS）

api.setPagePopGesture(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
openPagePopGesture	Boolean	是	是否开启侧滑关闭手势
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置系统状态栏样式（仅支持iOS和部分安卓）

api.setStatusBarStyle(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
style	String	是	系统状态栏样式（"dark"：深色前景色样式、"light"：浅色前景色样式）
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

获取系统状态栏样式（仅支持iOS和部分安卓）

api.getStatusBarStyle(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回系统状态栏样式 style（"dark"：深色前景色样式、"light"：浅色前景色样式）
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

进入全屏模式

api.enterFullscreen(CALLBACK)

CALLBACK返回参数：

无

离开全屏模式

api.leaveFullscreen(CALLBACK)

CALLBACK返回参数：

无

H5+ API初始化完毕

api.plusReady(CALLBACK)

CALLBACK返回参数：

无

判断是否APP环境

api.isApp

判断是否Android环境

api.isAndroid

判断是否iOS环境

api.isIos

获取客户端推送标识信息

api.getPushInfo(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回客户端推送标识信息
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

客户端推送标识信息

参数	类型	说明
appid	String	应用在个推申请的appid
appkey	String	应用在个推申请的appkey
clientid	String	本机的clientid
token	String	本机的token

监听推送消息点击

api.onPushClick(CALLBACK)

CALLBACK返回参数：

参数	类型	说明
title	String	消息标题
content	String	消息内容
payload	String	附加内容

清空推送消息

api.clearPushMessage()

调用第三方地图进行导航

api.openSysMap(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
latitude	Number	是	纬度，范围为-90~90，负数表示南纬
longitude	Number	是	经度，范围为-180~180，负数表示西经
name	String	否	位置名
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

查询启动界面是否显示状态

api.hasSplashscreen()

关闭启动界面

api.closeSplashscreen()

监听页面滚动

api.onScroll(CALLBACK)

CALLBACK返回参数：

参数	类型	说明
scrollLeft	Number	当前页面的document.body.scrollLeft
scrollTop	Number	当前页面的document.body.scrollTop

滚动页面到指定位置

api.scrollTo(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
scrollLeft	Number	否	缺省为0
scrollTop	Number	否	缺省为0

显示页面的垂直滚动条

api.showScrollIndicator()

隐藏页面的垂直滚动条

api.hideScrollIndicator()

启动美洽客服界面

api.startMeiqia(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
info	Object	否	需要携带的信息
group	String	否	指定客服分组ID
agent	String	否	指定客服ID
message	String	否	启动客服界面后的预发送消息
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

获取美洽ID

api.getMeiqiaClientId(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回美洽ID clientId
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置美洽ID

api.setMeiqiaClientId(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
clientId	String	是	美洽ID
success	Function	否	接口调用成功的回调，返回美洽ID clientId
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

监听页面显示

api.onPageShow(CALLBACK)

CALLBACK返回参数：

无

获取当前页面信息

api.getPage(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回页面id
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

事件监听

api.on(EVENT,CALLBACK)

取消事件监听

api.off(EVENT,CALLBACK)

主动触发事件

api.emit(EVENT,DATA,PAGEID)

登录

api.login(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
target	String	是	要获取登录信息的应用（qq、weixin）
success	Function	否	接口调用成功的回调，返回登录数据
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

支付

api.requestPayment(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
target	String	是	支付方式（alipay、wxpay）
statement	Object	是	支付订单信息，不同的支付方式不同（支付宝订单参数、微信订单参数）
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

监听应用进入后台

api.onAppPause(CALLBACK)

监听应用返回前台继续运行

api.onAppResume(CALLBACK)

获取设备信息

api.getDeviceInfo(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调,返回设备信息（imei、imsi、mac、uuid）
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

获取状态栏高度

api.statusbarHeight()

获取顶部安全区插入位置

api.getSafeAreaInsetTop()

获取底部安全区插入位置

api.getSafeAreaInsetBottom()

获取系统音量

api.getVolume(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调,返回系统音量（value）
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置系统音量

api.setVolume(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
value	Number	是	要设置的系统音量值，0到1，0为静音，1为最大音量
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）