HyAppApi文档

版本：1.1

主要约定和说明

历史记录

日期	作者	内容
2017-02-28	PS	新增混合App接口文档
2017-05-04	PS	App基础通知
2017-05-04	PS	新增[语音识别 延迟]
2017-05-04	PS	新增[WebView约定 3.1.0]

说明

• 带删除线的接口为废弃接口，但仍在使用。不再使用的接口会直接从文档删除

接口公共属性说明

返回格式

字段	数据类型	备注
status	Integer	状态码：-1-系统错误 0-成功 1-参数错误 2-业务错误 3-权限错误 特殊跳转： 20001-需实名认证引导 20002-需视频认证引导 20003-需商家入驻引导 20004-需设置交易密码 20005-需设置融宝结算卡 20006-需设置易宝结算卡
msg	String	状态对应消息
data	Object	返回数据

格式一：无返回值

 
{"status":0, "msg":"操作成功", "data":null}
		
		
		
		
		
		

		

		
		
		

格式二：返回对象

 
{"status":0, "msg":"成功", "data":{"orderNo":"HZ16110102111166", "totalAmount":100.00},response:null}
		
		
		
		
		
		

		

		
		
		

格式三：返回列表

 
{"status":0, "msg":"成功", "data":[
​
    {"id":1, "name":"商品1", "desc":"商品描述1"},
​
    {"id":2, "name":"商品2", "desc":"商品描述2"}
​
],response:null}
		
		
		
		
		

		

		
		
		

格式四：返回分页列表

 
{"status":0, "msg":"成功","data":{
    "pageNo":1,
    "pageSize":20,
    "totalCount":0,
    "totalPage":0,
    "extraData":null,
    "data":[{
        "id":379681,
        "productId":8801,
        "name":"沣瑞祥翡翠",
        "pictures":[
            {"pictureId":154223,"pictureUrl":"GetPicture?PictureId=154223"},
            {"pictureId":154223,"pictureUrl":"GetPicture?PictureId=154223"}
        ]
    },{
        "id":379682,
        "productId":8802,
        "name":"沣瑞祥翡翠",
        "pictures":[
            {"PictureId":154223,"pictureUrl":"GetPicture?PictureId=154223"},
            {"PictureId":154223,"pictureUrl":"GetPicture?PictureId=154223"}
        ]
    }]
}}
		
		
		
		
		

		

		
		
		

数据类型

类型	备注
String	字符串
Long	长整型，注：所有long型数据均会以String的格式传递
Integer	整型
Double	双精度浮点型
Decimal	高精度小数表示
List	列表
T	范型，KV结构数据
DateTime	时间，默认为yyyy-MM-dd HH:mm:ss格式 特殊会备注对应格式

WebView标准约定

• 当url中出现_zktg=_blank时停止对当前Url加载并打开外部游览器打开该Url (3.1.0)
• 当url中出现_zktg=_close_blank时停止对当前Url加载并打开外部游览器打开该Url,并关闭当前webview (3.1.0)
• 当url中出现_zktg=_self时在当前webView中加载该Url (3.1.0)
• 默认内部打开 (3.1.0)
• 当是扫描进入的时候默认外部打开 (3.1.0)
• 标签规定行为覆盖默认行为

其它约定

• 发送的时间格式为yyyy-MM-dd HH:mm:ss
• 返回超过【long】型数字时请返回字符串（因js当前不支持超过int型的数字长度，过长会被自动截断补充0）
• 所有插件命名空间／包名均为 com.hyapp.插件名
• 当请求参数集为空时请使用默认参数

交互约定

发起通知

• 方法调用 HyAppNative.excute(className, methodName, id, params) $HyApp.nativeSendResult(id, result)
• App主动发起通知 $HyApp.publish(key, result)

规则要求

• 无

参考文档

• 无

项目结构

 
  xsf-hyapp-plugins/ #插件库
    |-- trunk/ # 线上环境代码
    | |-- TestProject/ # 插件开发测试项目
    | | |-- CordovaHyApp/ # 插件开发测试项目
    |-- tags/
    |-- branches/ # 当前开发版本
    |-- README.md/ # 说明文档
    
  xsf-hyapp/ #标准蓝本项目
    |-- trunk/ # 线上环境代码
    | |-- CordovaHyApp/ # 标准蓝本项目
    |-- tags/
    |-- branches/ # 当前开发版本
​
  xsf-web
    |-- shared/ # xsf-分享
    | |-- trunk/ # 线上环境代码
    | |-- tags/
    | |-- branches/ # 当前开发版本
    |-- webview/ # App支持相关
    | |-- trunk/ # 线上环境代码
    | |-- tags/
    | |-- branches/ # 当前开发版本
    |-- collect_payment_webapp/ # 收付款WebApp
    | |-- trunk/ # 线上环境代码
    | |-- tags/
    | |-- branches/ # 当前开发版本
    |-- collect_payment_hyapp/ # 收付款混合App
    | |-- trunk/ # 线上环境代码
    | |-- tags/
    | |-- branches/ # 当前开发版本
		
		
		
		
		

		

		
		
		

基础插件

说明：

• 为App提供各种基础软件或者硬件功能服务

分享服务API

HYAShared

发起分享

HYAShared.excute(type,title,imgURL,content,clickURL)

作者：PS

[3.0.5]

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
type	Integer	否	分享类型 1.QQ 2.WX 3.WXCircle 4.SMS 5.CopyLink 6.QR[3.0.5暂时不做] 7.QQSpace
title	String	否	分享标题
imgURL	String	否	分享图片地址
content	String	是	分享内容
clickURL	String	是	点击文本块后访问地址

返回数据：

• 无

【通知】麦克风通知

hyaudio-mic-monitor-data

作者：PS

时间：2017-05-05

• 原生支持 3.1.0

返回数据：

字段	数据类型	可空	备注
soundSize	Double	否	声音大小 / 分贝

语音识别

HYAAudio.recognize

作者：PS

时间：2017-05-05

• 原生支持 (延迟)

请求数据：

字段	数据类型	可空	备注
minValue	Double	否	进行识别的最小音量
maxValue	Double	否	进行识别的最大音量
time	Double	否	监听时长 单位秒

返回数据：

字段	数据类型	可空	备注
contents	List<String>	否	识别出的内容列表

加载音频文件

HYAAudio.load

• 【原生】3.0.5 3.0.7去除

作者：PS

时间：2017-04-15

请求数据：

字段	数据类型	可空	备注
url	String	否	音频资源地址

返回数据：

• 无

文件上传服务API

HYAFile

文件类型

作者：PS

时间：2017-02-27

Props

字段	CODE	备注
FILE	1
IMG	2
AUDIO	3
VIDEO	4
BMP	5
GIF	6
JPEG	7
SVG	8
PNG	9
WebP	10
AVI	11
MPEG4	12
RM	13
MOV	14
RMVB	15
WMV	16
ASF	17
MPEG	18
XML	19
Zip	20
MP3	21
WAV	22
WMA	23
AAC	24
AC3	25
AIFF	26
FLAC	27
M4A	28

上传

HYAFile.upload(serverURL,fileInfos,dealParam)

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
serverURL	String	是	服务器上传接口地址
fileInfos	List<T1>	是	文件列表／null自行获取文件信息
dealParam	T2	是	上传前处理参数

T1 => fileInfo

字段	数据类型	可空	备注
path	String	是	文件所在本地路径／数据唯一标示

T2 => dealParam

字段	数据类型	可空	备注
quality	Double	是	建议压缩质量（WebApp模式时无效）
maxSize	Double	是	最大上传大小／byte
width	Double	是	宽度／px（图片时有效）
height	Double	是	高度／px（图片时有效）
rejectMaxSize	Double	是	直接拒绝最大大小／byte
rejectMinSize	Double	是	直接拒绝最小大小／byte

返回数据：List

字段	数据类型	可空	备注
path	String	是	文件所在本地路径／数据唯一标示
resourcesId	String	否	服务器返回资源Id
resourcesUrl	String	否	服务器返回资源地址（带http://）

选择文件

HYAFile.select(dealParam,success,error,allowSelectCount,serverURL,allowTypes)

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
allowSelectCount	Integer	否	允许做多选中数量/1单选
allowTypes	List<Integer>	是	允许的 文件类型

返回数据：List

字段	数据类型	可空	备注
path	String	否	文件所在本地路径 / 标示
resourcesId	String	是	服务器返回资源Id
resourcesUrl	String	是	服务器返回资源地址（带http://）
type	Integer	是	文件格式 文件类型

支付服务API

待设计

地图／定位服务API

待设计

OCR识别服务API

待设计

日历／时间选择器服务API

待设计

扫描二维码／条码服务API

HYAScanCode

扫描二维码

HYAScanCode.scanQR()

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
path	String	是	文件所在本地路径／数据唯一标示

返回数据：

字段	数据类型	可空	备注
content	String	否	图形码包含内容

扫描条形码

HYAScanCode.scanBarCode()

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
path	String	是	文件所在本地路径／数据唯一标示

返回数据：

字段	数据类型	可空	备注
content	String	否	图形码包含内容

通知服务API

待设计

基础框架服务API

【通知】二维码关闭时通知

hyaqr-close

作者：PS

时间：2017-02-27

返回数据：

字段	数据类型	可空	备注
code	String	否	二维码唯一编号

【通知】二维码保存完成时通知

hyaqr-save-complete

作者：PS

时间：2017-02-27

返回数据：

字段	数据类型	可空	备注
saveResult	Integer	否	1.保存成功 2.保存失败

获取设置API

HYAMySetting

• 获取音效设置
• 原生版本3.0.5

HYAMySetting.get

获取设置

作者：PS

时间：2017-02-27

请求数据：

• 无

返回数据：

字段	数据类型	可空	备注
countingAudio	Integer	否	点钞音效 0关闭 1开启
collectionAudio	Integer	否	收款音效 0关闭 1开启
appVersion	String	否	当前App版本号

摇一摇监测API

HYAShakeMonitor

• 摇一摇监测
• 原生版本3.0.5

开始监监听

HYAShakeMonitor.start

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
hasVibration	Integer	是	是否伴随振动 0.否 1.是 默认为1 (3.1.0) 待新增振动控制接口

返回数据：

• 无

注:

• App进入后台是自动停止监听
• App进入前台是自动重启监听(前提是开启监听的情况下进入后台)
• 返回上一个页面时自动停止监听

停止监听

HYAShakeMonitor.stop

作者：PS

时间：2017-02-27

请求数据：

• 无

返回数据：

• 无

【通知】摇一摇时通知

HYAShakeMonitorHasShake

作者：PS

时间：2017-02-27

返回数据：

• 无

公共控制API

HYACommonCtrl

• 公共控制接口

初始设置

HYACommonCtrl.init

• 原生版本3.0.5

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
title	String	否	页面标题
stopInjectJS	Integer	是	停止js注入 0.否 1.是

设置导航栏

HYACommonCtrl.setNav

作者：PS

时间：2017-02-27

请求数据：

字段	数据类型	可空	备注
title	String	否	页面标题

App基础通知

【通知】App进入后台

• 原生版本3.1.0

hya-notice-to-background

返回数据：

• 无

【通知】App进入前台

• 原生版本3.1.0

hya-notice-to-foreground

返回数据：

• 无