接口文档
版本记录
接口版本 | app起始版本 | 修订记录 |
---|---|---|
1.7 | 7.0.2.1 | 增加智能柜V2接口 |
1.6 | 6.0.1.15 | 1.新增智能柜接口 2. 新增保温柜接口 |
1.5 | 6.0+ | 1.新增honeywell打印机接口和扫码接口 |
1.4 | 5.1.5.1 | 1. 新增AJAX接口 2.新增储物柜扫码接口 |
1.3 | 5.1.0.1 | 1. 新增 储物柜接口 2. 新增 会议平板灯带控制 |
1.2 | 4.3.4.6 | 新增"VR" |
1.1 | 4.3 | 新增"网络" |
1.0 | 4.1 | 初版 |
传感
温度传感
开启监控
- 方法: temperature.boway_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
温度 | temperature | float | N |
关闭监控
- 方法: temperature.boway_stop_1
- 输入: 无
- 输出: 无
RFID
开启RFID
- 方法: rfid.common_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N |
- 使用示例:
longjing.call('rfid.common_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":数据data
// }
// }
});
关闭RFID
- 方法: rfid.common_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
longjing.call('rfid.common_stop_1');
人体感应
开启亚为人体红外
- 方法: infrared.yav_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N |
- 使用示例:
longjing.call('infrared.yav_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":数据data
// }
// }
});
关闭亚为人体红外
- 方法: infrared.yav_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
longjing.call('infrared.yav_stop_1');
开启GY53人体红外
- 方法: infrared.gy53_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N | 输出距离 单位mm |
- 使用示例:
longjing.call('infrared.gy53_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":数据data
// }
// }
});
关闭GY53人体红外
- 方法: infrared.gy53_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
longjing.call('infrared.gy53_stop_1');
语音
语音播报
语音播报
- 方法: tts.speak
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
文本 | text | string | N | 需要语音叫号的内容 |
- 输出: 异步输出
示例
longjing.call('tts.speak',{text:'需要语音叫号的内容'},function(){
// 语音叫号完毕后的处理
});
增强
VR
启动PicoVR播放器
- 方法: vr.pico_startPlayer
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
地址 | uri | string | N | 视频文件地址 |
类型 | videoType | int | N | 说明 |
- videoType
视频类型 | 说明 | 参数 |
---|---|---|
_2D | 2D | 0 |
_3D_LR | 3D左右 | 1 |
_360 | 全景2D | 2 |
_3D360_TB | 全景3D上下 | 3 |
_3D360_BT | 全景3D下上 | 4 |
_3D360_LR | 全景3D左右 | 5 |
_3D360_RL | 全景3D右左 | 6 |
_3D_TB | 3D上下 | 7 |
_3D_BT | 3D下上 | 8 |
_3D_RL | 3D右左 | 9 |
_180 | 180°2D | 10 |
_3D180_TB | 180°3D上下 | 11 |
_3D180_BT | 180°3D下上 | 12 |
_3D180_LR | 180°3D左右 | 13 |
_3D180_RL | 180°3D右左 | 14 |
_2DFishEye | FishEye 2D | 15 |
_3DFishEye_TB | FishEye 3D上下 | 16 |
_3DFishEye_BT | FishEye 3D下上 | 17 |
_3DFishEye_LR | FishEye 3D左右 | 18 |
_3DFishEye_RL | FishEye 3D右左 | 19 |
_CubeMap | Youtube | 20 |
_CubeMap_LR | Youtube 3D左右 | 21 |
- 同步输出:无
示例
let bridgeData = longjing.call("vr.pico_startPlayer",{
"uri":"地址", // 调用下载时传入的分组号
"videoType": 0
});
关闭PicoVR播放器
- 方法:vr.pico_exitPlayer
- 输入: 无
- 同步输出:无
示例
let bridgeData = longjing.call("vr.pico_exitPlayer");
播放或暂停
- 方法:vr.pico_playOrPause
- 说明: 若播放器此时是播放状态,会暂停,若此时是暂停状态,会继续播放
- 输入: 无
- 同步输出:无
示例
let bridgeData = longjing.call("vr.pico_playOrPause");
获取播放器状态
- 方法: vr.pico_getStatus
- 说明: 先注册状态通知,再调用此方法
- 输入: 无
- 同步输出:无
示例
let bridgeData = longjing.call("vr.pico_getStatus");
播放器状态通知
- 方法: VR_PICO_PLAYER_STATUS_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态 | status | int | N | NOT_READY = 0; READY = 1; END = 2; PLAYING = 3; PAUSED = 4; STOPPED = 5; ERROR = 6; |
示例
// 只需注册一次,调用vr.pico_getStatus会通过回调进行通知
longjing.register("VR_PICO_PLAYER_STATUS_NOTIFY",function(bridge){
if(bridge.code == 0){
let data = bridge.data; // data = {status:""};
}else{
// js和app通讯桥异常
}
});
IC卡管理
开启读卡
- 方法: icCard.common_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
卡号 | number | String | N |
- 使用示例:
longjing.call('icCard.common_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "number":"3382738723"
// }
// }
});
关闭读卡
- 方法: icCard.common_stop_1
- 输入: 无
- 输出: 无
开启nfc读卡
- 方法: icCard.nfc_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
卡号 | number | String | N |
关闭nfc读卡
- 方法: icCard.nfc_stop_1
- 输入: 无
- 输出: 无
保温柜
连接设备
- 方法: insulatedCabinet.openDevice
- 输入: 无
- 输出: 无
开灯
- 方法: insulatedCabinet.openLight
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态 | status | int | N | 1 成功, 其他 失败 |
关灯
- 方法: insulatedCabinet.closeLight
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态 | status | int | N | 1 成功, 其他 失败 |
开门
- 方法: insulatedCabinet.openDoor
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态 | status | int | N | 1开门成功, 2开门失败(485、接线正常), 3超时, 4其他异常 |
检查门状态
- 方法: insulatedCabinet.checkDoorStatus
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态 | status | int | N | 1门关, 2门开, 3 异常 |
开保温
- 方法: insulatedCabinet.openInsulation
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 输出:无
关保温
- 方法: insulatedCabinet.closeInsulation
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡号 | boardNum | int | N | |
编号 | num | int | N |
- 输出:无
刀具柜
开启副柜
- 方法: knifeToolCabinet.enableSlave
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
副柜1 | slave1 | bool | N | true 开启 |
副柜2 | slave2 | bool | N | true 开启 |
- 输出: 无
连接设备
- 方法: knifeToolCabinet.openDevice
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
串口类型 | portType | string | N | (ttyS、ttyUSB等) ttyS |
串口号 | port | int | N | 4 |
波特率 | baud | int | N | 38400 |
- 输出: 无
出货
- 方法: knifeToolCabinet.outGoods
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
货道号 | aisle | int | N | 主柜:(col-1)10 + (row-1) 副柜:100+ (col-1)10 + (row-1) 例如:3行3列就是 100+20+2=122 |
- 输出: 异步输出
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
货道号 | aisle | int | N | |
结果 | state | int | N | 0:无故障出货成功。其他:有故障但出货成功。 |
异常输出
code | msg |
---|---|
-1 | 出货失败 |
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
货道号 | aisle | int | N | |
错误码 | errCode | int | N | |
失败原因 | failureStr | int | N |
智能柜
连接设备
- 方法: cabinet.openDevice
- 输入: 无
- 输出: 无
开启循环
- 方法: cabinet.openCheck
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
防抖时间 | filterTime | int | Y | 默认1s ,单位毫秒 |
- 输出: 无
关闭循环
- 方法: cabinet.closeCheck
- 输入: 无
- 输出: 无
设置称端口数量
- 方法: cabinet.setPortCount
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数量 | count | int | N |
- 输出: 无
设置砝码重量
- 方法: cabinet.setWeighValue
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
重量 | value | int | N | 取值范围:0-65535 |
- 输出: 无
去皮
- 方法: cabinet.removePeel
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N |
- 输出: 无
设置精度(回差值)
- 方法: cabinet.setAccuracy
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
重量 | value | int | N | 0-255 |
- 输出: 无
称重
- 方法: cabinet.weigh
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N |
- 输出: 无
批量称重
- 方法: cabinet.batchWeigh
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
称重命令发送间隔 | interval | int | Y | 默认80ms |
额外参数 | args | string | Y | |
端口列表 | portArray | jsonArray | N | [1,2,3] |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
执行是否成功 | isSuccess | bool | N | 如果正在执行批量称重,会返回false |
称重通知
- 方法: CABINET_WEIGHT_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
时事件编码 | code | string | N | 0 //称重事件, 1 //去皮, 2 //写入砝码值, 3 //开检查, 4 //关检查, 5 //设置端口数, 6 //设置回差值, 7 //批量称重通知 |
端口 | port | int | Y | code = 0 或 1 或 2 |
重量 | weight | int | Y | code =0 |
是否成功 | isSuccess | bool | Y | code = 5 或 6 |
回执消息(指令) | msg | string | Y | code !=0 |
批量称重结果 | weightArray | JsonArray | Y | code = 7 [{"port":1,"weight":100}] |
额外参数 | args | string | Y | code =7 |
控制灯
- 方法: cabinet.controlLamp
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
类型 | type | string | N | switch //开关, flashing //闪烁 |
数据 | data | JsonArray | N |
data
[ {
"row": 1,
"color": "red",
"col": [ 1, 2, 3 ]
}, {
"row": 1,
"color": "green",
"col": [ 1, 2, 3 ]
}, {
"row": 2,
"color": "red",
"col": [ 1, 2, 3 ]
}, {
"row": 2,
"color": "green",
"col": [ 1, 2, 3 ]
}, {
"row": 3,
"color": "red",
"col": [ 1, 2, 3 ]
}, {
"row": 3,
"color": "green",
"col": [ 1, 2, 3 ]
}]
- 输出: 无
关闭所有灯
- 方法: cabinet.closeLamp
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
类型 | type | string | N | switch //开关, flashing //闪烁 |
- 输出: 无
灯控通知
- 方法: CABINET_LAMP_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
是否成功 | isSuccess | int | N |
- 输出: 无
开门
- 方法: cabinet.openDoor
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
锁号 | num | int | N |
开所有门
- 方法: cabinet.openAllDoor
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N |
检查门状态
- 方法: cabinet.checkDoorStatus
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
锁号 | num | int | N |
门状态通知
- 方法: CABINET_DOOR_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
事件编码 | code | int | N | 0 //主动开门返回, 1 //门主动上报, 2 //检查门状态 |
端口 | port | int | N | |
锁号 | num | int | N | |
是否打开 | isOpen | int | N |
智能柜V2
连接设备
- 方法: cabinetV2.openDevice
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
开启副柜 | enableSlave | bool | Y | 默认false |
- 输出: 无
开启循环
- 方法: cabinetV2.openCheck
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
防抖时间 | filterTime | int | Y | 默认1s ,单位毫秒 |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
关闭循环
- 方法: cabinetV2.closeCheck
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
设置称端口数量
- 方法: cabinetV2.setPortCount
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数量 | count | int | N | |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
设置砝码重量
- 方法: cabinetV2.setWeighValue
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
重量 | value | int | N | 取值范围:0-65535 |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
去皮
- 方法: cabinetV2.removePeel
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
设置精度(回差值)
- 方法: cabinetV2.setAccuracy
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
重量 | value | int | N | 0-255 |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
称重
- 方法: cabinetV2.weigh
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 输出: 无
批量称重
- 方法: cabinetV2.batchWeigh
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
称重命令发送间隔 | interval | int | Y | 默认80ms |
额外参数 | args | string | Y | |
端口列表 | portArray | jsonArray | N | [1,2,3] |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
执行是否成功 | isSuccess | bool | N | 如果正在执行批量称重,会返回false |
称重通知
- 方法: CABINET_WEIGHT_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
时事件编码 | code | string | N | 0 //称重事件, 1 //去皮, 2 //写入砝码值, 3 //开检查, 4 //关检查, 5 //设置端口数, 6 //设置回差值, 7 //批量称重通知 |
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
端口 | port | int | Y | code = 0 或 1 或 2 |
重量 | weight | int | Y | code =0 |
是否成功 | isSuccess | bool | Y | code = 5 或 6 |
回执消息(指令) | msg | string | Y | code !=0 |
批量称重结果 | weightArray | JsonArray | Y | code = 7 [{"port":1,"weight":100}] |
额外参数 | args | string | Y | code =7 |
控制灯
- 方法: cabinetV2.controlLamp
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
数据 | data | JsonArray | N |
data
[ {
"port": 1,
"status": 1,//0关闭,1开启
},{
"port": 1,
"status": 1,
}]
- 输出: 无
灯控通知
- 方法: CABINET_LAMP_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
柜编号 | cabinetNum | int | N | 0主柜,1副柜 |
端口 | port | int | N | |
状态 | status | int | N | //0关闭,1开启 |
- 输出: 无
开门
- 方法: cabinetV2.openDoor
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
锁号 | num | int | N |
开所有门
- 方法: cabinetV2.openAllDoor
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N |
检查门状态
- 方法: cabinetV2.checkDoorStatus
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
端口 | port | int | N | |
锁号 | num | int | N |
门状态通知
- 方法: CABINET_DOOR_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
事件编码 | code | int | N | 0 //主动开门返回, 1 //门主动上报, 2 //检查门状态 |
端口 | port | int | N | |
锁号 | num | int | N | |
是否打开 | isOpen | int | N |
储物柜
打开
- 方法: locker.common_open_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
门编号 | number | int | N |
- 输出: 无
获取所有串口路径
- 方法: locker.common_getAllPath_1
- 输入: 无
- 输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
串口路径 | allPath | array | N | [/dev/ttyS0,/dev/ttyS1,...] |
打开V2
- 方法: locker.common_open_2
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
串口路径 | path | string | N | |
门编号 | number | int | N |
- 输出: 无
485锁打开
- 方法: locker.serial485_open_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡编号 | cardNumber | int | N | 1,2,3,4 |
门编号 | number | int | N |
- 输出: 无
485锁打开全部
- 方法: locker.serial485_openAll_1
- 输入: 无
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
板卡编号 | cardNumber | int | N | 1,2,3,4 |
- 输出: 无
灯管理
设置颜色
- 方法: lamp.common_set_color_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | int | N | DEVICE_DR = 1;//德睿 DEVICE_QS = 2;//仟视(四周灯带) DEVICE_SKW = 3;//盛科维 DEVICE_CUSTOM = 5;//定制设备 |
颜色 | color | int | N | if( type == DEVICE_SKW ){ 16进制指令 例如: ff0000 红色 }else { LED_OFF = 0; // 关灯 LED_COLOR_RED = 1; // 红灯 LED_COLOR_GREEN = 2; // 绿灯 LED_COLOR_YELLOW = 3; // 黄灯 } |
- 输出: 无
设置颜色2
- 方法: lamp.common_set_color_2
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | int | N | DEVICE_QS2 = 4;//仟视2(两边灯带) |
颜色 | color | int | N | LED_OFF = 0; // 关灯 LED_COLOR_RED = 1; // 红灯 LED_COLOR_GREEN = 2; // 绿灯 LED_COLOR_YELLOW = 3; // 黄灯 LED_COLOR_BLUE = 4; // 蓝灯 LED_COLOR_CYAN = 5; // 青灯 LED_COLOR_PURPLE = 6; // 紫灯 LED_COLOR_WHITE = 7; // 白灯 |
亮度值 | progress | int | Y | 0-15,不传默认10 |
- 输出: 无
打印机
设置型号
- 方法: printer.common_setModel_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
型号 | model | int | N |
| ||||||||||||||||||||||
连接方式 | connectionMethod | int | Y | 东芝打印需要设置
| ||||||||||||||||||||||
地址 | ip | string | Y | Honeywell_PC42D&&东芝&&连接方式为网络 | ||||||||||||||||||||||
端口号 | port | int | Y | Honeywell_PC42D&&东芝&&连接方式为网络 |
- 输出: 无
获取型号
- 方法: printer.common_getModel_1
- 输入: 无
- 输出: 同步输出
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
型号 | model | int | N |
| ||||||||||||||||||||||
地址 | ip | string | N | GP_D320_FX&&Honeywell_PC42D&&东芝&&连接方式为网络 | ||||||||||||||||||||||
端口号 | port | int | N | GP_D320_FX&&Honeywell_PC42D&&东芝&&连接方式为网络 |
断开连接
- 方法: printer.common_disconnect_1
- 输入: 无
- 输出: 无
商米打印
- 方法: printer.sunmi_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N |
Command
对齐方式
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | alignMode |
模式 | mode | int | N | 对齐方式 0--居左 , 1--居中, 2--居右 |
字体大小
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | fontZoom |
大小 | size | int | N | 1,2,3,4 |
换行
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | lineWrap |
行数 | num | int | N | 1,2,3,4 |
文本
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | text |
文本 | text | stirng | N |
二维码
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
类型 | type | String | N | qrCode | ||||||||||
内容 | content | stirng | N | |||||||||||
二维码块大小 | modeSize | int | N | 二维码块大小(单位:点, 取值 1 至 16 ) | ||||||||||
错误级别 | errorLevel | int | N |
|
图片
名称 | 字段 | 类型 | 可选 | 说明 | 备注 |
---|---|---|---|---|---|
类型 | type | String | N | image | base64 |
模式 | mode | int | N | 0 原式大小 |
切刀
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | cutPaper |
- 输出: 无
商米指令打印
- 方法: printer.sunmi_commandPrint_1
- 输入:
称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
ECS/POS指令 | command | JsonArray | N | byte数组 |
- 输出: 无
商米门票打印
- 方法: printer.sunmi_ticketPrint_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N | |
执行参数 | execution | JsonObject | N |
Command
文本
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | text |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
旋转角度 | rotation | int | N | 0.90,180,270 |
横向缩放 | xScale | int | N | 水平放大比率,有效参数>1,常用值10 |
纵向缩放 | yScale | int | N | 垂直放大比率,有效参数>1,常用值10 |
文本 | text | String | N |
二维码
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | qrCode |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
cell 尺寸 | cell | int | N | 有效参数 1~10 |
内容 | content | String | N |
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
宽 | width | int | N | |
高 | height | String | N | |
图片 | base64 | String | N | base 去头 图片格式必须为纯黑白且位深为1 |
切刀
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | cutPaper |
进纸距离 | n | int | Y | 进纸距离,单位 dot, 默认值: TscPrinter.DEF_FEED=320 |
execution
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
纸宽度 | width | int | N | 打印区域宽度 ,单位 dot,超出区域的数据将被丢弃 |
纸高度 | height | int | N | 打印区域高度, 同上 |
- 输出: 无
东芝连接打印机
- 方法: printer.toshiba_connect_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
连接方式 | connectionMethod | int | N |
| ||||||
地址 | ip | string | Y | 连接方式为网络 | ||||||
端口号 | port | int | Y | 连接方式为网络 |
- 输出: 同步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
是否连接 | connect | bool | N | true 成功 |
东芝打印
- 方法: printer.toshiba_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N | |
执行参数 | execution | JsonObject | N |
Command
坐标,宽高单位均为 dmm
文本
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | text |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
旋转角度 | rotation | String | N | ROTATION_0("00"),//0度 ROTATION_90("11"),//90度 ROTATION_180("22"),//180度 ROTATION_270("33");//270度 |
字体类型 | fontType | String | N | FONT_A("A"),//Times Roman (Medium) FONT_G("B"),//Helvetica (Medium) FONT_M("M"),//Presentation (Bold) FONT_N("N"),//Letter Gothic (Medium) FONT_O("O"),//Prestige Elite (Medium) FONT_Q("Q"),//Courier (Medium) CHINESE("r"); |
横向缩放 | xScale | String | N | 指定可放大0.5单位 (0.5至9.5放大倍率)。 放大倍数可以在0.5到1之间以0.1单位指定。 (0.6至0.9放大倍率) |
纵向缩放 | yScale | String | N | 同上 |
文本 | text | String | N |
线
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | line |
开始x坐标 | startX | int | N | |
开始y坐标 | startY | int | N | |
结束x坐标 | endX | int | N | |
结束y坐标 | endY | int | N | |
线类型 | lineType | int | N | LINE_1(0), LINE_2(1); |
线宽 | width | int | N | 可选参数 1-9 |
二维码
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | qrCode |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
块宽 | width | int | N | |
内容 | content | String | N |
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
宽 | width | int | N | |
高 | height | String | N | |
图片 | base64 | String | N | base 去头 图片格式必须为纯黑白且位深为1 |
execution
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
纸宽度 | width | int | N | |
纸高度 | height | int | N | |
间隙 | gap | int | N | |
打印份数 | num | int | N | image |
打印速度 | speed | int | N | SPEED1(1), SPEED2(2), SPEED3(3), SPEED4(4), SPEED5(5), SPEED6(6); |
打印方向 | direction | int | N | FORWARD(0), BACKWARD(1); |
- 输出: 无
东芝指令打印
- 方法: printer.toshiba_commandPrint_1
- 输入:
称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
Tec指令 | command | JsonArray | N | byte数组 |
- 输出: 无
Honeywell_PC42D连接打印机
- 方法: printer.honeywell_connect_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
连接方式 | connectionMethod | int | N |
| ||||||
地址 | ip | string | Y | 连接方式为网络 |
Honeywell_PC42D打印
- 方法: printer.honeywell_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N |
Command
文本
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | text |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
字体类型 | fontType | String | Y | 默认 MHeiGB18030C-Medium |
字体大小 | fontSize | String | N | |
文本 | text | String | N |
线
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | line |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
线长 | length | int | N | |
线宽 | width | int | N |
二维码
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | qrCode |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
放大倍数 | enlargeWidth | int | N | |
内容 | content | String | N |
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
图片 | base64 | String | N | base 去头,图片必须是黑白无灰度的图片,格式支持PNG, GIF,BMP, 及 PCX. |
- 输出: 无
Honeywell_PR500D打印
- 方法: printer.honeywellPR500D_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N | |
执行参数 | execution | JsonObject | N |
Command
文本
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
类型 | type | String | N | text | ||||||||||||||||
x坐标 | x | int | N | |||||||||||||||||
y坐标 | y | int | N | |||||||||||||||||
字体类型(大小) | fontType | String | N |
| ||||||||||||||||
文本 | text | String | N |
二维码
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | qrCode |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
放大倍数 | enlargeWidth | int | N | |
内容 | content | String | N |
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
宽度 | width | int | N | |
图片 | base64 | String | N | base 去头 |
execution
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印宽度 | printWidth | int | N |
- 输出: 无
GP_D320_FX连接
- 方法: printer.gpD320FX_connect_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 | ||||||
---|---|---|---|---|---|---|---|---|---|---|
连接方式 | connectionMethod | int | N |
| ||||||
地址 | ip | string | Y | 连接方式为网络 |
GP_D320_FX打印
- 方法: printer.gpD320FX_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N | |
执行参数 | execution | JsonObject | N |
Command
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
宽度 | width | int | N | |
图片 | base64 | String | N | base 去头 |
execution
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印宽度 | printWidth | int | N | |
打印高度 | printHeight | int | N | |
间隙 | gap | int | N | 单位mm |
- 输出: 无
MAI_CHI打印
- 方法: printer.maiChi_print_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印指令 | command | JsonArray | N | |
执行参数 | execution | JsonObject | N |
Command
图片
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
类型 | type | String | N | image |
x坐标 | x | int | N | |
y坐标 | y | int | N | |
宽度 | width | int | N | |
图片 | base64 | String | N | base 去头 |
execution
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
打印宽度 | printWidth | int | N | |
打印高度 | printHeight | int | N |
- 输出: 无
人证验证
商汤授权
- 方法:iDAuth.sensetime_verify
- 输入: 无
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
验证类型 | verifyType | int | N |
| ||||||||||
图片列表 | images | JsonArray | N | 需要哪些图传递哪些
|
- 输出: 异步输出
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
姓名 | name | string | N | |
男 | sex | string | N | |
名族 | ethnicity | string | N | |
生日 | birth | string | N | 1996.02.10 |
卡号 | id_number | string | N | |
签发机关 | authority | string | N | |
签发日志 | issue_date | string | N | 2008.05.18 |
过期时间 | expire_date | string | N | 2028.05.17 |
验证类型 | credential_type | string | N | 居⺠身份证 |
验证结果 | verify_result | bool | N | false |
验证备注 | verify_remark | string | N | 脸 |
验证分数 | verify_score | float | N | 0.98 |
验证时间戳 | verify_time | long | N | 1573095897302 |
证件照图 | id_image | string | Y | base64 |
现场人脸小图 | face_image | string | Y | base64 |
现场大图 | live_image | string | Y | base64 |
ocr识别图 | ocr_image | string | Y | base64 |
异常输出
code | msg |
---|---|
-1 | 验证超时 |
通用授权
- 方法:iDAuth.common_verify
- 输入: 无
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
验证类型 | verifyType | int | N |
| ||||||||
图片列表 | images | JsonArray | N | 需要哪些图传递哪些
|
- 输出: 异步输出
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
姓名 | name | string | N | |
男 | sex | string | N | |
名族 | nation | string | N | |
生日 | birthday | string | N | |
住址 | address | string | N | |
卡号 | number | string | N | |
签发机关 | department | string | N | |
签发日志 | startDate | string | N | |
过期时间 | endDate | string | N | |
验证结果 | isPass | bool | N | false |
验证分数 | similar | float | N | 0.98 |
证件照图 | imagePath | string | Y | base64 |
现场人脸小图 | facePath | string | Y | base64 |
现场大图 | livePath | string | Y | base64 |
异常输出
code | msg |
---|---|
-1 | 验证超时 |
人脸登陆
方法:iDAuth.face_login
输入: 无
输出: 异步输出
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
编码 | code | int | N | |
消息 | msg | string | N |
异常输出
code | msg |
---|---|
-1 | 验证超时 |
身份证读卡
设置型号
- 方法: idCardReader.common_setModel_1
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
内容 | model | int | N |
|
- 输出: 无
获取型号
- 方法: idCardReader.common_getModel_1
- 输入: 无
- 输出: 同步输出
名称 | 字段 | 类型 | 可选 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
内容 | model | int | N |
|
开启读卡
- 方法: idCardReader.common_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
姓名 | name | string | N | |
卡号 | cardID | string | N | |
地址 | address | string | N | |
生日 | birth | string | N | |
性别 | sex | string | N | |
名族 | nation | string | N | |
签发部门 | depart | string | N | |
有效期 | validDate | string | N | |
头像 | photo | string | N | base64 |
停止读卡
- 方法: idCardReader.common_stop_1
- 输入: 无
- 输出: 无
扫码
开启商米扫码
- 方法: scanCode.summi_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N | 扫码数据 |
- 使用示例:
longjing.call('scanCode.summi_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":扫码数据
// }
// }
});
关闭商米扫码
- 方法: scanCode.summi_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
开启honeywell扫码
- 方法: scanCode.honeywell_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N | 扫码数据 |
- 使用示例:
longjing.call('scanCode.summi_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":扫码数据
// }
// }
});
关闭honeywell扫码
- 方法: scanCode.honeywell_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
开启储物柜扫码
- 方法: scanCode.locker_start_1
- 输入: 无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
数据 | data | JSON String | N | 扫码数据 |
- 使用示例:
longjing.call('scanCode.locker_start_1',function(res){
// 异步输出数据 res.data.data
// res数据结构如下:
// {
// "code":0,
// "data":{
// "data":扫码数据
// }
// }
});
关闭储物柜扫码
- 方法: scanCode.locker_stop_1
- 输入: 无
- 输出: 无
- 使用示例:
WebView窗口
展示
- 方法: subWebView.show
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
地址 | url | string | N | |
宽 | width | int | N | |
高 | height | int | N | |
距离左边位置 | left | int | N | |
距离顶部位置 | top | int | N |
- 输出: 无
隐藏
方法: subWebView.hide
输入: |名称|字段|类型|可选|说明| |--|--|--|--|--| |地址|url|string|Y|可选参数, 可以隐藏时加载首页使用|
输出: 无
返回上一页
方法: subWebView.goBack
输入: 无
输出: 无 |名称|字段|类型|可选|说明| |--|--|--|--|--| |是否可以返回|canGoBack|bool|N|已经返回到首页了会返回 false|
nfc功能
丰灼写图片
- 方法: nfc.fz_writeImage
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
图片 | base64 | string | N | |
宽 | width | int | N | |
高 | height | int | N |
- 异步输出:
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
卡号 | cardNum | string | N | 16进制 |
异常输出
code | msg |
---|---|
-1 | 取消 |
读卡
- 方法: nfc.readCard
- 输入:
- 异步输出:
正常输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
卡号 | cardNum | string | N | 16进制 |
异常输出
code | msg |
---|---|
-1 | 取消 |
系统
系统管理
获取系统配置信息
- 方法: 见示例
- 输入: 无
- 输出:
名称 | 字段 | 类型 | 说明 |
---|---|---|---|
设备 | deviceNumber | string | 同时是:设备号、屏幕号 |
商户 | sellerId | string | |
网点 | pointNo | string | |
H5小应用 | appId | string |
示例
let deviceNumber = longjing.property('deviceNumber');
设置系统时间
- 方法: sys.systemTime_set
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
时间 | time | string | N | 命令格式:MMddHHmmyyyy.ss (月日时分年.秒) 例如:052514192019.22 |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
设置状态 | status | bool | N | true 成功,false 失败 |
当前页面加载完成,通知底层
- 方法: sys.webView_pageLoadFinish
- 输入: 无
- 输出: 无
示例
longjing.call('sys.webView_pageLoadFinish');
注册键盘改变事件的回调函数
- 方法: sys.registerSoftInputChanged
- 输入:无
- 输出: 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
内容 | visible | bool | N | true显示, false隐藏 |
示例
longjing.call('sys.registerSoftInputChanged', fn);
网络
报文请求
- 方法:net.request
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
请求地址 | url | string | N | |
请求类型 | method | string | N | POST, GET |
超时时间 | timeout | number | Y | 单位毫秒,默认10000ms |
请求数据 | data | json string | Y | 不传为空字符串 |
请求头 | headers | json object | Y | 参考如下 |
headers
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
内容类型 | contentType | string | Y | application/json |
- 异步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
状态码 | statusCode | number | N | -1 请求错误,其他对应 http 状态码 |
响应数据 | responseText | json object | N | statusCode !=-1 时 返回该字段 |
状态信息 | statusMessage | string | Y | statusCode == -1 时, 返回错误信息 |
点秀API的responseText
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
业务状态码 | code | number | N | 0代表成功 |
业务异常信息 | message | string | Y | code !=0 时,返回异常信息 |
业务数据 | data | json object | Y | code == 0 时, 返回该字段 |
示例(获取点秀的资源列表API)
let deviceNumber = longjing.config("deviceNumber"); // 设备号
longjing.call("net.request",{
"method": "POST",
"url": "https://www.pointshow.net/api/resource/terminal-search",
"data":JSON.stringify({
"queryFolder": false,
"dirType": 2,
"parentPath": "/" + (deviceNumber || ""),// 此处是以设备编号创建的文件夹
"types": ["image", "video"],
"queryChild": false,
"index": 0,
"size": 100
}),
"headers":{
"contentType":"application/json"
}
},function(bridge){
if(bridge.code == 0){ // js和app通讯成功
let response = bridge.data;
if(response.statusCode != -1){ // app发送请求成功
let responseText = response.responseText;
if(responseText.code == 0){ // 业务数据正常
let resourceData = responseText.data; // 资源列表数据
}
}else{
// 网络连接异常,异常原因:response.statusMessage
}
}else{
// js和app通讯桥异常
}
});
下载
- 方法:net.download
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
下载列表 | urlList | array object | N | |
分组号 | tag | array object | N |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
全部下载状态 | status | number | N | 0成功 1待下载 |
下载结果 | result | json array | N | 详细参考如下 |
result
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
链接 | url | string | N | 入参中需要下载的连接 |
下载状态 | status | number | N | 0成功 1待下载 |
本地路径 | path | string | N |
示例
let bridgeData = longjing.call("net.download",{
"urlList":["资源url","资源url","资源url"],
"tag":"自定义分组号"
});
if(bridgeData.code == 0){
let resourceData = bridgeData.data.result; // resourceData [{url:"",status:0,path:""}]
}else{
// 异常:bridgeData.message
}
获取下载信息
- 方法:net.getDownloadInfo
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
分组号 | tag | array object | N | 调用下载时传入的分组号 |
- 同步输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
全部下载状态 | status | number | N | 0成功 1待下载 |
下载结果 | result | json array | N | 详细参考如下 |
result
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
链接 | url | string | N | 入参中需要下载的连接 |
下载状态 | status | number | N | 0成功 1待下载 |
本地路径 | path | string | N |
示例
let bridgeData = longjing.call("net.getDownloadInfo",{
"tag":"自定义分组号" // 调用下载时传入的分组号
});
if(bridgeData.code == 0){
let resourceData = bridgeData.data.result; // resourceData [{url:"",status:0,path:""}]
}else{
// 异常:bridgeData.message
}
下载完成通知
- 方法:NET_DOWNLOAD_COMPLETE_NOTIFY
- 输入:无
- 异步输出
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
链接 | url | string | N | 入参中需要下载的连接 |
本地路径 | path | string | N |
示例
// 只需注册一次,每个资源下载完成都会通过回调进行通知
longjing.register("NET_DOWNLOAD_COMPLETE_NOTIFY",function(bridge){
if(bridge.code == 0){
let data = bridge.data; // data = {url:"",path:""};
}else{
// js和app通讯桥异常
}
});
应用配置
读取当前应用的所有配置
- 方法: config.app_read_all
- 输入: 无
- 输出:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
内容 | content | JSON Object | N | 说明 |
示例
let config = longjing.call('config.app_read_all').content;
写入当前应用的所有配置
- 方法: config.app_write_all
- 输入:
名称 | 字段 | 类型 | 可选 | 说明 |
---|---|---|---|---|
内容 | content | JSON Object | N | 说明 |
- 输出: 无
示例
longjing.call('config.app_write_all',{content:'{"ver", "1.0"}'}); // 此方式会覆盖所有配置内容