1.3.5 • Published 5 years ago

touchui-api v1.3.5

Weekly downloads
11
License
ISC
Repository
-
Last release
5 years ago

API

WeTouch(TouchUI) API

使用文档

使用浏览器打开网址

api.openBrowser(OBJECT)

OBJECT参数说明

参数类型必填说明
urlString要浏览的页面地址
systemBoolean是否使用系统浏览器打开(默认为:false,使用内置浏览器打开)
backgroundColorString标题栏背景颜色
colorString标题栏文字颜色
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

扫码

api.scanCode(OBJECT)

OBJECT参数说明

参数类型必填说明
onlyFromCameraBoolean是否只能从相机扫码,不允许从相册选择图片
backgroundColorString标题栏背景颜色
colorString标题栏文字颜色
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

判断指纹硬件是否可用

api.canUseTouchID(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

使用指纹进行验证

api.useTouchID(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

分享到第三方应用

api.share(OBJECT)

OBJECT参数说明

参数类型必填说明
targetString要分享到的应用(weixin_timeline、weixin_message、weibo、qq)
typeString分享类型(link、text、image 默认为link)
titleString分享标题(分享类型需为link)
contentString分享内容(分享类型为text时必选)
iconString分享缩略图(分享类型需为link、图片大小需要小于30Kb)
hrefString分享链接(分享类型需为link)
picturesArray分享图片(分享类型需为image、图片地址不支持网络路径、部分平台仅支持分享一张图片)
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

选择联系人电话号码

api.pickPhoneNumber(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回电话号码 phoneNumber
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

监听状态栏点击事件(仅支持iOS)

api.onStatusbarTap(CALLBACK)

CALLBACK返回参数:

监听返回按钮点击事件

api.onBackButtonClick(CALLBACK)

CALLBACK返回参数:

取消监听返回按钮点击

api.offBackButtonClick(OBJECT)

OBJECT参数说明

参数类型必填说明
listenerFunction要移除的事件监听回调函数
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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

api.getPagePopGesture(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回手势是否开启(openPagePopGesture)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

设置页面的侧滑关闭手势(仅支持iOS)

api.setPagePopGesture(OBJECT)

OBJECT参数说明

参数类型必填说明
openPagePopGestureBoolean是否开启侧滑关闭手势
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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

api.setStatusBarStyle(OBJECT)

OBJECT参数说明

参数类型必填说明
styleString系统状态栏样式("dark":深色前景色样式、"light":浅色前景色样式)
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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

api.getStatusBarStyle(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回系统状态栏样式 style("dark":深色前景色样式、"light":浅色前景色样式)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

进入全屏模式

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参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回客户端推送标识信息
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
客户端推送标识信息
参数类型说明
appidString应用在个推申请的appid
appkeyString应用在个推申请的appkey
clientidString本机的clientid
tokenString本机的token

监听推送消息点击

api.onPushClick(CALLBACK)

CALLBACK返回参数:

参数类型说明
titleString消息标题
contentString消息内容
payloadString附加内容

清空推送消息

api.clearPushMessage()

调用第三方地图进行导航

api.openSysMap(OBJECT)

OBJECT参数说明

参数类型必填说明
latitudeNumber纬度,范围为-90~90,负数表示南纬
longitudeNumber经度,范围为-180~180,负数表示西经
nameString位置名
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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

api.hasSplashscreen()

关闭启动界面

api.closeSplashscreen()

监听页面滚动

api.onScroll(CALLBACK)

CALLBACK返回参数:

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

滚动页面到指定位置

api.scrollTo(OBJECT)

OBJECT参数说明

参数类型必填说明
scrollLeftNumber缺省为0
scrollTopNumber缺省为0

显示页面的垂直滚动条

api.showScrollIndicator()

隐藏页面的垂直滚动条

api.hideScrollIndicator()

初始化美洽客服

api.initMeiqia(OBJECT)

OBJECT参数说明

参数类型必填说明
appKeyString美洽 App Key
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

启动美洽客服界面

api.startMeiqia(OBJECT)

OBJECT参数说明

参数类型必填说明
infoObject需要携带的信息
groupString指定客服分组ID
agentString指定客服ID
messageString启动客服界面后的预发送消息
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

获取美洽ID

api.getMeiqiaClientId(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回美洽ID clientId
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

设置美洽ID

api.setMeiqiaClientId(OBJECT)

OBJECT参数说明

参数类型必填说明
clientIdString美洽ID
successFunction接口调用成功的回调,返回美洽ID clientId
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

监听页面显示

api.onPageShow(CALLBACK)

CALLBACK返回参数:

获取当前页面信息

api.getPage(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回页面id
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

事件监听

api.on(EVENT,CALLBACK)

取消事件监听

api.off(EVENT,CALLBACK)

主动触发事件

api.emit(EVENT,DATA,PAGEID)

登录

api.login(OBJECT)

OBJECT参数说明

参数类型必填说明
targetString要获取登录信息的应用(qq、weixin)
successFunction接口调用成功的回调,返回登录数据
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

支付

api.requestPayment(OBJECT)

OBJECT参数说明

参数类型必填说明
targetString支付方式(alipay、wxpay)
statementObject支付订单信息,不同的支付方式不同(支付宝订单参数微信订单参数
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

监听应用进入后台

api.onAppPause(CALLBACK)

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

api.onAppResume(CALLBACK)

获取设备信息

api.getDeviceInfo(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回设备信息(imei、imsi、mac、uuid)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

获取状态栏高度

api.statusbarHeight()

获取顶部安全区插入位置

api.getSafeAreaInsetTop()

获取底部安全区插入位置

api.getSafeAreaInsetBottom()

获取左侧安全区插入位置

api.getSafeAreaInsetLeft()

获取右侧安全区插入位置

api.getSafeAreaInsetRight()

获取安全区插入位置

api.getSafeAreaInsets(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回安全区信息(top、left、right、bottom)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

监听安全区插入位置变更

api.onSafeAreaInsetsChange(CALLBACK)

CALLBACK返回参数:

参数类型说明
topNumbersafeAreaInsets.top
leftNumbersafeAreaInsets.left
rightNumbersafeAreaInsets.right
bottomNumbersafeAreaInsets.bottom

获取系统音量

api.getVolume(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回系统音量(value)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

设置系统音量

api.setVolume(OBJECT)

OBJECT参数说明

参数类型必填说明
valueNumber要设置的系统音量值,0到1,0为静音,1为最大音量
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

开始语音识别

api.startSpeechRecognize(OBJECT)

OBJECT参数说明

参数类型必填说明
timeoutNumber无语音输入识别超时时间,单位:毫秒,默认10秒
langString语言类型(zh-cn:中文-普通话;en-us:英语;zh-cantonese:中文-粤语;zh-henanese:中文-河南话。 默认值为“zh-cn”)
punctuationBoolean识别结果中是否包含标点符号,默认:false
successFunction接口调用成功的回调,返回识别结果(text)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

停止(取消)语音识别

api.stopSpeechRecognize()

安装软件包(wgt、apk)

api.installPackage(OBJECT)

OBJECT参数说明

参数类型必填说明
srcString安装包的路径(可以是临时文件路径或存储文件路径,网络路径需先下载)
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

获取当前应用信息

api.getAppInfo(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回当前应用信息
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
应用信息
参数类型说明
appNameString应用名称
versionString应用版本
runtimeVersionString应用运行环境版本

比较版本信息

api.compareVersions(v1,v2)

返回(Number)

  • 1:v1版本高
  • 0:v1和v2版本相等
  • -1:v1版本低

关闭APP

api.closeApp()

重启APP

api.restartApp()

获取启动参数

api.getLaunchArguments(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回启动参数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
启动参数
参数类型说明
argumentsString应用的启动参数

监听从其他应用启动事件

api.onLaunch(CALLBACK)

测试能否打开URL

api.canOpenURL(OBJECT)

OBJECT参数说明

参数类型必填说明
urlString要测试打开的URL
successFunction接口调用成功的回调,返回appList
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
success返回参数说明

参数|类型|说明 appList|Array|可以打开此URL的应用列表(安卓返回应用包名,iOS返回URL)

打开URL

api.openURL(OBJECT)

OBJECT参数说明

参数类型必填说明
urlString要打开的URL
identityString要打开应用的包名(安卓)
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

设置本地化语言

api.setI18n(OBJECT)

OBJECT参数说明

参数类型必填说明
localeString语言类型
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

打开数据库

api.openDatabase(OBJECT)

OBJECT参数说明

参数类型必填说明
nameString数据库名称
pathString数据库路径
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

执行sql语句参数

api.executeSql(OBJECT)

OBJECT参数说明

参数类型必填说明
nameString数据库名称
sqlStringsql语句
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

执行事务操作

api.executetTansaction(OBJECT)

OBJECT参数说明

参数类型必填说明
nameString数据库名称
operationString事务操作类型(begin、commit、rollback)
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

执行sql查询

api.selectSql(OBJECT)

OBJECT参数说明

参数类型必填说明
nameString数据库名称
sqlStringsql语句
successFunction接口调用成功的回调,返回查询结果
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
success返回参数说明
参数类型说明
dataArray查询到的结果集合

关闭数据库

api.closeDatabase(OBJECT)

OBJECT参数说明

参数类型必填说明
nameString数据库名称
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

扫描打印机

api.scanPrinters(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调,返回查询结果
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)
success返回参数说明
参数类型说明
printersArray打印机名称集合

连接打印机

api.connectPrinter(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

开始打印

api.startPrint(OBJECT)

OBJECT参数说明

参数类型必填说明
widthNumber打印区域宽度,单位mm
heightNumber打印区域高度,单位mm
orientationNumber旋转角度,支持0、90、180、270
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

创建打印机上下文对象

api.createPrinterContext() 创建并返回printerContext对象

printerContext对象的方法列表

方法参数类型说明
setItemOrientationorientationNumber设置顺时针旋转角度,支持0、90、180、270
setItemHorizontalAlignmentalignmentString设置水平对齐方式,支持left、center、right
setItemVerticalAlignmentalignmentString设置垂直对齐方式,支持top、center、bottom
drawTextOBJECTObject绘制文本
drawBarcodeOBJECTObject绘制条形码
drawQRCodeOBJECTObject绘制二维码
drawImageOBJECTObject绘制图像
drawLineOBJECTObject绘制线条
drawRoundRectangleOBJECTObject绘制圆角矩形
drawText 的 OBJECT 参数列表:
参数类型必填说明
textString要绘制的文本
xNumber绘制文本的x坐标,单位mm
yNumber绘制文本的y坐标,单位mm
widthNumber文本绘制的宽度,单位mm
heightNumber文本绘制的高度,单位mm
fontHeightNumber文字高度,单位mm
drawBarcode 的 OBJECT 参数列表:
参数类型必填说明
textString条形码内容
xNumber绘制条形码的x坐标,单位mm
yNumber绘制条形码的y坐标,单位mm
widthNumber条形码绘制的宽度,单位mm
heightNumber条形码绘制的高度,单位mm
drawQRCode 的 OBJECT 参数列表:
参数类型必填说明
textString二维码内容
xNumber绘制二维码的x坐标,单位mm
yNumber绘制二维码的y坐标,单位mm
widthNumber二维码绘制的宽度,单位mm
heightNumber二维码绘制的高度,单位mm
drawImage 的 OBJECT 参数列表:
参数类型必填说明
pathString图像地址
xNumber绘制图像的x坐标,单位mm
yNumber绘制图像的y坐标,单位mm
widthNumber图像绘制的宽度,单位mm
heightNumber图像绘制的高度,单位mm
drawLine 的 OBJECT 参数列表:
参数类型必填说明
xNumber绘制线条的x坐标,单位mm
yNumber绘制线条的y坐标,单位mm
widthNumber线条绘制的宽度,单位mm
heightNumber线条绘制的高度,单位mm
drawRoundRectangle 的 OBJECT 参数列表:
参数类型必填说明
xNumber绘制圆角矩形的x坐标,单位mm
yNumber绘制圆角矩形的y坐标,单位mm
widthNumber圆角矩形绘制的宽度,单位mm
heightNumber圆角矩形绘制的高度,单位mm
lineWidthNumber边框宽度,单位mm
radiusNumber圆角大小,单位mm
isFilledBoolean是否填充

提交打印

api.commitPrint(OBJECT)

OBJECT参数说明

参数类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

关闭打印机连接

api.closePrinter()

1.3.5

5 years ago

1.3.4

6 years ago

1.3.3

6 years ago

1.3.2

6 years ago

1.3.1

6 years ago

1.3.0

6 years ago

1.2.3

6 years ago

1.1.3

6 years ago

1.1.2

6 years ago

1.1.1

6 years ago

1.1.0

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.0

6 years ago

0.9.0

6 years ago

0.8.7

6 years ago

0.8.6

6 years ago

0.8.5

6 years ago

0.8.4

6 years ago

0.8.3

6 years ago

0.8.2

6 years ago

0.8.1

6 years ago

0.8.0

6 years ago

0.7.5

6 years ago

0.7.4

6 years ago

0.7.3

6 years ago

0.7.2

6 years ago

0.7.1

6 years ago

0.7.0

6 years ago

0.6.0

6 years ago

0.5.1

6 years ago

0.5.0

6 years ago

0.4.3

6 years ago

0.4.2

6 years ago

0.4.1

6 years ago

0.4.0

6 years ago

0.3.3

6 years ago

0.3.2

6 years ago

0.3.1

6 years ago

0.3.0

6 years ago

0.2.77

6 years ago

0.2.76

6 years ago

0.2.75

6 years ago

0.2.74

6 years ago

0.2.73

6 years ago

0.2.72

6 years ago

0.2.71

6 years ago

0.2.70

6 years ago

0.2.69

6 years ago

0.2.68

6 years ago

0.2.67

6 years ago

0.2.66

6 years ago

0.2.65

6 years ago

0.2.64

6 years ago

0.2.63

6 years ago

0.2.62

6 years ago

0.2.61

6 years ago

0.2.60

6 years ago

0.2.59

6 years ago

0.2.58

6 years ago

0.2.57

6 years ago

0.2.56

6 years ago

0.2.55

6 years ago

0.2.54

6 years ago

0.2.53

6 years ago

0.2.52

6 years ago

0.2.51

6 years ago

0.2.50

6 years ago

0.2.49

6 years ago

0.2.48

6 years ago

0.2.47

6 years ago

0.2.46

6 years ago

0.2.45

6 years ago

0.2.44

6 years ago

0.2.43

6 years ago

0.2.42

6 years ago

0.2.41

6 years ago

0.2.40

6 years ago

0.2.39

6 years ago

0.2.38

6 years ago

0.2.37

6 years ago

0.2.36

6 years ago

0.2.35

6 years ago

0.2.34

6 years ago

0.2.33

6 years ago

0.2.32

6 years ago

0.2.31

6 years ago

0.2.30

6 years ago

0.2.29

7 years ago

0.2.28

7 years ago

0.2.27

7 years ago

0.2.26

7 years ago

0.2.25

7 years ago

0.2.24

7 years ago

0.2.23

7 years ago

0.2.22

7 years ago

0.2.21

7 years ago

0.2.20

7 years ago

0.2.19

7 years ago

0.2.18

7 years ago

0.2.17

7 years ago

0.2.16

7 years ago

0.2.15

7 years ago

0.2.14

7 years ago

0.2.13

7 years ago

0.2.12

7 years ago

0.2.11

7 years ago

0.2.10

7 years ago

0.2.9

7 years ago

0.2.8

7 years ago

0.2.7

7 years ago

0.2.6

7 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.2

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago

0.1.34

7 years ago

0.1.33

7 years ago

0.1.32

7 years ago

0.1.31

7 years ago

0.1.30

7 years ago

0.1.29

7 years ago

0.1.27

7 years ago

0.1.26

7 years ago

0.1.25

7 years ago

0.1.24

7 years ago

0.1.23

7 years ago

0.1.22

7 years ago

0.1.21

7 years ago

0.1.20

7 years ago

0.1.19

7 years ago

0.1.18

7 years ago

0.1.17

7 years ago

0.1.16

7 years ago

0.1.15

7 years ago

0.1.14

7 years ago

0.1.13

7 years ago

0.1.12

7 years ago

0.1.11

7 years ago

0.1.10

7 years ago

0.1.9

7 years ago

0.1.8

7 years ago

0.1.7

7 years ago

0.1.6

7 years ago

0.1.5

7 years ago

0.1.4

7 years ago

0.1.3

7 years ago

0.1.2

7 years ago

0.1.1

7 years ago

0.1.0

7 years ago

0.0.9

7 years ago

0.0.8

7 years ago

0.0.7

7 years ago

0.0.6

7 years ago

0.0.5

7 years ago

0.0.4

7 years ago

0.0.3

7 years ago

0.0.2

7 years ago

0.0.1

7 years ago