touchui-api
Advanced tools
以小程序API方式调用h5+API
暂不处理
api.openBrowser(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| url | String | 是 | 要浏览的页面地址 |
| system | Boolean | 否 | 是否使用系统浏览器打开（默认为：false，使用内置浏览器打开） |
| backgroundColor | String | 否 | 标题栏背景颜色 |
| color | String | 否 | 标题栏文字颜色 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.scanCode(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| onlyFromCamera | Boolean | 否 | 是否只能从相机扫码，不允许从相册选择图片 |
| backgroundColor | String | 否 | 标题栏背景颜色 |
| color | String | 否 | 标题栏文字颜色 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.canUseTouchID(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.useTouchID(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.share(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)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回电话号码 phoneNumber |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.onStatusbarTap(CALLBACK)
无
api.onBackButtonClick(CALLBACK)
无
api.offBackButtonClick(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| listener | Function | 是 | 要移除的事件监听回调函数 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.getPagePopGesture(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调,返回手势是否开启（openPagePopGesture） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.setPagePopGesture(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openPagePopGesture | Boolean | 是 | 是否开启侧滑关闭手势 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.setStatusBarStyle(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| style | String | 是 | 系统状态栏样式（"dark"：深色前景色样式、"light"：浅色前景色样式） |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.getStatusBarStyle(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回系统状态栏样式 style（"dark"：深色前景色样式、"light"：浅色前景色样式） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.enterFullscreen(CALLBACK)
无
api.leaveFullscreen(CALLBACK)
无
api.plusReady(CALLBACK)
无
api.isApp
api.isAndroid
api.isIos
api.getPushInfo(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回客户端推送标识信息 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| 参数 | 类型 | 说明 |
|---|---|---|
| appid | String | 应用在个推申请的appid |
| appkey | String | 应用在个推申请的appkey |
| clientid | String | 本机的clientid |
| token | String | 本机的token |
api.onPushClick(CALLBACK)
| 参数 | 类型 | 说明 |
|---|---|---|
| title | String | 消息标题 |
| content | String | 消息内容 |
| payload | String | 附加内容 |
api.clearPushMessage()
api.openSysMap(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| latitude | Number | 是 | 纬度，范围为-90~90，负数表示南纬 |
| longitude | Number | 是 | 经度，范围为-180~180，负数表示西经 |
| name | String | 否 | 位置名 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.hasSplashscreen()
api.closeSplashscreen()
api.onScroll(CALLBACK)
| 参数 | 类型 | 说明 |
|---|---|---|
| scrollLeft | Number | 当前页面的document.body.scrollLeft |
| scrollTop | Number | 当前页面的document.body.scrollTop |
api.scrollTo(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scrollLeft | Number | 否 | 缺省为0 |
| scrollTop | Number | 否 | 缺省为0 |
api.showScrollIndicator()
api.hideScrollIndicator()
api.startMeiqia(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| info | Object | 否 | 需要携带的信息 |
| group | String | 否 | 指定客服分组ID |
| agent | String | 否 | 指定客服ID |
| message | String | 否 | 启动客服界面后的预发送消息 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.getMeiqiaClientId(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回美洽ID clientId |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.setMeiqiaClientId(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| clientId | String | 是 | 美洽ID |
| success | Function | 否 | 接口调用成功的回调，返回美洽ID clientId |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.onPageShow(CALLBACK)
无
api.getPage(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回页面id |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.on(EVENT,CALLBACK)
api.off(EVENT,CALLBACK)
api.emit(EVENT,DATA,PAGEID)
api.login(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| target | String | 是 | 要获取登录信息的应用（qq、weixin） |
| success | Function | 否 | 接口调用成功的回调，返回登录数据 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.requestPayment(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| target | String | 是 | 支付方式（alipay、wxpay） |
| statement | Object | 是 | 支付订单信息，不同的支付方式不同（支付宝订单参数、微信订单参数） |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.onAppPause(CALLBACK)
api.onAppResume(CALLBACK)
api.getDeviceInfo(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调,返回设备信息（imei、imsi、mac、uuid） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.statusbarHeight()
api.getSafeAreaInsetTop()
api.getSafeAreaInsetBottom()
api.getSafeAreaInsetLeft()
api.getSafeAreaInsetRight()
api.getSafeAreaInsets(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调,返回安全区信息（top、left、right、bottom） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.onSafeAreaInsetsChange(CALLBACK)
| 参数 | 类型 | 说明 |
|---|---|---|
| top | Number | safeAreaInsets.top |
| left | Number | safeAreaInsets.left |
| right | Number | safeAreaInsets.right |
| bottom | Number | safeAreaInsets.bottom |
api.getVolume(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调,返回系统音量（value） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.setVolume(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | Number | 是 | 要设置的系统音量值，0到1，0为静音，1为最大音量 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.startSpeechRecognize(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| timeout | Number | 否 | 无语音输入识别超时时间，单位：毫秒，默认10秒 |
| lang | String | 否 | 语言类型（zh-cn：中文-普通话；en-us：英语；zh-cantonese：中文-粤语；zh-henanese：中文-河南话。 默认值为“zh-cn”） |
| punctuation | Boolean | 否 | 识别结果中是否包含标点符号，默认：false |
| success | Function | 否 | 接口调用成功的回调，返回识别结果（text） |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.stopSpeechRecognize()
api.installPackage(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| src | String | 否 | 安装包的路径（可以是临时文件路径或存储文件路径，网络路径需先下载） |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
api.getAppInfo(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回当前应用信息 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| 参数 | 类型 | 说明 |
|---|---|---|
| appName | String | 应用名称 |
| version | String | 应用版本 |
| runtimeVersion | String | 应用运行环境版本 |
api.compareVersions(v1,v2)
api.closeApp()
api.restartApp()
api.getLaunchArguments(OBJECT)
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | Function | 否 | 接口调用成功的回调，返回启动参数 |
| fail | Function | 否 | 接口调用失败的回调函数 |
| complete | Function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
| 参数 | 类型 | 说明 |
|---|---|---|
| arguments | String | 应用的启动参数 |
api.onLaunch(CALLBACK)
FAQs
touchui api
The npm package touchui-api receives a total of 253 weekly downloads. As such, touchui-api popularity was classified as not popular.
We found that touchui-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
