混合开发接口文档

混合开发接口文档

通用

页面引入js文件

js文件版本在添加升级功能时地址会变化，如有需要（比如要使用新增的js-api）,请随时关注地址变更。但是旧版本js文件也将一直可用。
http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid.js
这个脚本在客户端执行，判断平台后实际使用不同代码。如果想减少交互次数，可以在服务器直接判断平台后，调取不同的js代码。
Android：http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid/android/cordova.js
iOS：http://res.dinghuo123.com/app/ydh/dist/js/lib/hybrid/ios/cordova.js

全局变量、命名空间

直接引入hybird.js会得到一个全局变量ydh
命名空间：设备(ydh.device)、业务(ydh.biz)

权限验证

整个app采用全部H5嵌套，原生app只提供部分接口。
原生App应用模块的URL后面所需参数access_token，access_token由H5提供。

接口约定

• 所有接口都为异步
• 接受一个object类型的参数
• 成功回调onSuccess(某些异步接口的成功回调，将在事件触发时被调用，具体详情请查看相关onSuccess回调时机，未做描述的即为同步接口)
• 失败回调 onFail
• 如下showToast的接口：

function myBtnOneOnClick(){
   

    ydh.device.showToast(function(result){
   
        alert("success:"+result);
    },function(err){
   
        alert("error:"+err);
    },{
        text:'Hello world again!'
    });
}

设备

ydh.device

获取通用唯一识别码

• 接口名称

  ydh.device.getUuid

• 参数说明

  参数	参数类型	说明
  uuid	String	通用唯一识别码

获取手机APP版本号和版本名称

• 接口名称

  ydh.device.getAppVersion

• 参数说明

  参数	参数类型	说明
  platform	String	APP平台值：Android、iOS
  versionCode	String	APP的版本号
  versionName	String	APP的版本名称

获取当前网络类型

• 接口名称

  ydh.device.getNetworkType

• 参数说明

  参数	参数类型	说明
  result	String	result值: wifi、2g、3g、4g、unknown、none，none表示离线

toast

• 接口名称

  ydh.device.showToast

• 返回说明

  参数	参数类型	说明
  text	String	提示信息

业务

ydh.biz

帐号信息

• 接口说明
  为了确保数据的正确性，请在收到该接口成功回调后进行下一步操作

• 接口名称

  ydh.biz.setAccountData