更新日期:     浏览次数:

1. JS-API

qing.js 是为了方便前端人员在云之家环境调用native代码的工具类,兼容新版桌面端、老版桌面端、移动端、微信

1.1. 如何使用

1.1.1. 使用示例

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>示例</title>
</head>
<body>
  <!-- 引入qing -->
  <script src="//static.yunzhijia.com/public/js/qing/latest/qing.js"></script>
  <script>
    // 在 qing.config 执行前,所有其它的 ydk api 都不会真正被调用
    // 这里是一个简单的配置,其它 API list 请参考详细文档
    qing.config({
      debug : false,
      // 声明需要调用的API
      jsApiList : ['checkJsApi', 'share'],
      // 声明需要监听的事件,声明后可通过 document.addEventListener 绑定监听函数
      jsEventList: ['appear', 'disappear']
    });

    // 获取个人信息
    qing.call('getPersonInfo', {
      success : function(res){}
    });

    // 监听appear事件
    qing.on('appear', function(res){});
  </script>
</body>
</html>

离线版本qing.js下载

1.1.2. 接口调用说明

所有接口的调用形式为 qing.call('xxx', {...}),参数必须是一个对象。

每个接口除了自身必须的参数外,还支持以下通用参数:

  1. success:接口调用成功时执行的回调函数。
  2. error:接口调用失败时执行的回调函数。
  3. complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。

以上所述的回调函数的参数说明,如 success : function (res) { ... },这里的 res 为对象,除了每个接口自身返回的数据之外,还有两个通用属性 codeerrMsg,其值格式如下:

  1. 调用成功(success):{code: 200, errMsg: "", data: {}}
  2. 调用失败(error):{code: 500, errMsg: "不合法的图片文件大小", data: {}}

注: code 类型为数字,非字符串。

1.2. 附录1:所有 API 列表

1.2.1. 与 native 相关的 API

以下为 base api,也就是对第三方开放的无限制的部分

  1. qing.config
  2. qing.checkApi

qing 中还包含了一些为了便于编码便利而存在的一些辅助性 api

  1. qing.version,qing版本号
  2. qing.isSupportNativeJsBridge,当前 webview 支持桥
  3. qing.nativeJsBridgeVersion,当前客户端桥版本
  4. qing.hasOwn,见 Object.hasOwnProperty
  5. qing.isFunction,是否函数
  6. qing.isString,是否字符串
  7. qing.isNumber,是否数字
  8. qing.isObject,是否对象
  9. qing.isArray,是否数组
  10. qing.forEach,见 Array.prototype.forEach
  11. qing.keys,见Object.keys
  12. qing.ns,把字符串转换为命名空间,"a.b.c" 1.> {a:{b:{c:{}}}}
  13. qing.isWX,是否微信客户端
  14. qing.isChrome,是否 chrome
  15. qing.isFirefox,是否 firefox
  16. qing.isOpera,是否 opera
  17. qing.isSafari,是否 safari
  18. qing.isIe,是否 IE 浏览器,这个用法稍微不一样,如 qing.isIe() or qing.isIe(6)
  19. qing.isIphone,是否 iphone
  20. qing.isIpad,是否 ipad
  21. qing.isIpod,是否 ipod
  22. qing.isIos,是否 ios 平台
  23. qing.isAndroid,是否 Android 平台
  24. qing.isAndroidPhone,是否 Android 手机
  25. qing.isAndroidTable,是否 Android 平板
  26. qing.isBlackberry,是否黑莓
  27. qing.isMac,是否 mac 本
  28. qing.isWindows,是否 win 系统
  29. qing.isWindowsPhone,是否 win 手机
  30. qing.isWindowsTable,是否 win 平板
  31. qing.isMobile,是否手机
  32. qing.isDesktop,是否 PC 机
  33. qing.isTouchDevice,是否触屏设备

1.3. 附录2:全局返回码说明

注: code类型为数字,非字符串。

返回码 说明
100 调用成功,并且有多次返回
200 调用成功
404 接口不存在
500 全局调用失败code

1.4. 附录3:移动端UA信息说明

云之家App轻应用的UserAgent获取到的信息如下:

deviceId 设备ID
deviceName 设备名称
clientId 客户端ID,10200表示iOS端,10201表示Android端,10208表示iPad端
os 系统版本
brand 手机品牌
model 手机型号
lang 客户端当前语言,zh开头为中文,en开头为英文,目前仅支持中文和英文
fontNum 客户端当前字体大小,0表示标准字体,-1表示小号字体,1、2、3、4依次表示更大号字体(目前仅iOS端支持)

results matching ""

    No results matching ""