qap.json 配置

更新时间:2017/08/21 访问次数:4652

1 qap.json 文件

qap.json 可以用于设置插件的首页,支持的客户端最小版本,页面显示状态,资源配置等
完整的 qap.json 文件如下:

{
  "appKey": "12345678",
  "version": "1.0",
  "jssdk": "1.0.10",
  "min_qn_ios": "5.8.2",
  "min_qn_android": "5.8.2",
  "pages": [
    {
      "default": true,
      "capability": "itemChoose",
      "url": "qap:///index.js",
      "landscape": true
    }
  ],
  "iconfonts": [
    {
      "localpath": "font_1474198576_7440977.ttf",
      "url": "http://at.alicdn.com/t/font_1474198576_7440977.ttf"
    }
  ],
  "WebRootPath": "http://path/to/callback/url"
}

2 配置说明

2.1 插件配置项

设置插件的基础信息比如appkey,支持的客户端最小版本等。

名称 必需 默认值 作用 备注
appkey 插件的appkey 必须有效appkey才能发布,appkey为空可以进行调试,但是api调用会收到限制
version 插件的版本 上传离线包时,QNConsole在上传包时将读取该字段判断版本
min_qn_ios 支持的最小的iOS版本(含) 可以根据Api和组件的使用情况手动更改,默认自动生成推荐版本
min_qn_android 支持的最小的android版本(含) 可以根据Api和组件的使用情况手动更改,默认自动生成推荐版本
jssdk jssdk的版本 自动生成推荐版本

2.2 页面配置项

用于设置插件的页面打开和页面表现相关。对应qap.json中pages字段的子节点。
pages的子节点中必须要有一个default为true的页面,作为插件默认的打开页面。同时可以配置能力声明页面,根据不同场景(如交易消息点击)跳转到指定的插件页面具体见页面能力路由

名称 必需 默认值 作用 备注
default false 是否插件的首屏页面 true有且只出现一次
url 页面的地址 一般为格式:qap:///xxx.js,xxx为page名字
capability 页面能力声明  
landscape 是否横屏 默认为false

2.2 资源配置

名称 必需 默认值 作用 备注
iconfonts 本地iconfont文件声明 使用方式见: 这里
WebRootPath QAP的H5版本发布后的线上地址 这是在应用被降级到H5页面时前端使用rootPath,建议配置此项!具体请参考: 这里

FAQ

关于此文档暂时还没有FAQ
返回
顶部