config.xml应用配置说明

Overview

access

Preference

Feature

Permission

Meta-Data

Intent-Filter

Reference

Overview

概述

每一个Widget 包必须有一个名为 config.xml （大小写敏感）的配置文件，它位于Widget包的根目录下。该配置文件包含了关于该Widget的重要信息，如：名称、作者信息、描述、云端ID、偏好设置、权限配置、模块概览等等，并且该配置文件也是整个Widget的入口。

一个简单的config.xml文件配置清单如下：

  1. <widget id="A12345678901"  version="0.0.1">
  2.     <name>API Example</name>
  3.     <description>
  4.         API Example App.
  5.     </description>
  6.     <author email="developer@apicloud.com" href="//www.apicloud.com">
  7.         APICloud.SIR
  8.     </author>
  9.     <content src="index.html" />
  10.     <access origin="*" />
  11.     <preference name="windowBackground" value="#FFF" />
  12.     <permission name="call" />
  13.     <feature name="weiXin">
  14.         <param name="urlScheme" value="wx7779c7c063a9d4d9" />
  15.     </feature>
  16. </widget>

注：该XML文件必须采用UTF-8编码。

配置清单描述

widget父元素描述了该Widget的基本属性，如表1所示。

  • 表1. widget父元素的属性
属性名描述备注
id应用ID，由云服务器自动分配。它是该Widget在云端的唯一标识。云服务器根据此ID对Widget进行管理并提供辅助服务，如：更新升级、统计分析、推送服务等。必选
versionWidget的版本号必选
sandbox配置此属性后，APICloud应用在运行之初，将会在设备的SD卡上建立与此属性同名的文件夹根目录，并将该目录默认为本应用的沙箱根路径，此后应用运行过程中所有涉及的文件操作如：文件读写，拍照、下载等等，操作结果的文件都将存放在该路径下。该属性仅Android平台生效可选

配置中的XML元素如表2所示。

  • 表2. Widget配置元素
元素名描述备注
nameWidget的名称。如：QQ、新浪微博、微信等必选
descriptionWidget的简单描述信息可选
authorWidget的作者信息可选
contentWidget运行的起始页，支持相对/绝对路径必选
access在哪些页面里面可以访问APICloud的扩展API。一般配置“*”，代表所有页面都允许访问可选
preference偏好设置。配置Widget的一些运行时属性，如：页面是否支持弹动效果、窗口默认背景、页面是否显示滚动条等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Preference Guide可选
permission权限配置。通过此配置向系统声明Widget所用到的系统权限。如：直接拨打电话、直接发送短信、发起定位等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Platform Permission必选
feature功能配置。通过此配置，向系统声明需要使用哪些功能，以及需要传递给该功能的数据。如：使用新浪微博、使用微信分享等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Feature Guide可选
font字体配置。通过此配置，将自定义字体加入到应用中，使其可以在前端页面使用该字体可选

access

access用于配置在哪些类型的页面里面可以访问APICloud的扩展API方法，如访问api.sms()方法。一般配置“*”，代表所有页面都允许访问

字段名：origin

取值范围：

  • *：所有页面都可以访问扩展API方法，包括本地页面及远程web页面
  • local：只有本地页面可以访问扩展API方法
  • 其它域名：只有在该域及其子域下面的页面可以访问扩展API方法，注意我们这里未区分http和https，配置 http://apicloud.com 和 https://apicloud.com 效果一样
  • nojailbreak：不允许越狱的设备使用本应用。若配置，将不允许越狱的设备使用本应用。

默认值：*

描述：配置在哪些类型的页面里面可以访问APICloud的扩展API方法。

配置示例：

  1. <access origin="local" />
  2. <access origin="http://apicloud.com" />

Preference

Preference用于声明本应用的一些全局设置或者属性，该字段以键值对的形式存在。APICloud应用在启动及运行过程中会随时参考这些属性，以达到应用运行的最优状态。

配置App全局背景

字段名：appBackground

取值范围：

  • 颜色：#FFF，#FFFFFF，rgb(255,255,255)，rgba(255,255,255,1.0)；
  • 图片：相对widget包路径的url地址，如image/xxx.png

默认值：rgba(0,0,0,0.0)

描述：配置App的背景颜色或图片，默认为透明色。配置此字段后，如果window的背景为透明色，则将透射出App背景。APICloud应用的UI层次结构见图1.

配置示例：

  1. <preference name="appBackground" value="color|imageUrl" />

图1.APICloud应用UI层次结构图：

图片说明

若WindowBackground为透明，那么Window将展示App的背景，同时如果FrameBackground也为透明，那么Frame将展示App的背景。

配置Window默认背景

字段名：windowBackground

取值范围：

  • 颜色：#FFF，#FFFFFF，rgb(255,255,255)，rgba(255,255,255,1.0)；
  • 图片：相对widget包路径的url地址，如image/xxx.png

默认值：rgba(0,0,0,0.0)

描述：配置Window的背景颜色或图片，默认为透明色。配置此字段后，所有open的Window都会使用该背景，可提高开发效率、节省系统资源、加速渲染速度。

配置示例：

  1. <preference name="windowBackground" value="color|imageUrl" />

配置Frame默认背景

字段名：frameBackgroundColor

取值范围：

  • 颜色：#FFF，#FFFFFF，rgb(255,255,255)，rgba(255,255,255,1.0)；
  • 图片：相对widget包路径的url地址，如image/xxx.png

默认值：rgba(0,0,0,0.0)

描述：配置Frame的背景颜色或图片，默认为透明色。此字段的配置效果等同于对网页的body标签设置background-color。

配置示例：

  1. <preference name="frameBackgroundColor" value="color" />

配置页面是否弹动

字段名：pageBounce

取值范围：true|false

默认值：window默认为false，frame默认为true

描述：配置页面是否可以弹动。若不配置，window默认不弹动，frame默认可以弹动；若配置，则window和frame是否可以弹动默认都以此配置的为准。

配置示例：

  1. <preference name="pageBounce" value="false" />

配置页面默认是否显示滚动条

字段名：hScrollBarEnabled | vScrollBarEnabled

取值范围：true|false

默认值：true

描述：配置在页面高度超出视图高度时，window|frame是否显示横|竖滚动条。默认显示。

配置示例：

  1. 横向滚动条：
  2.         <preference name="hScrollBarEnabled" value="true|false" />
  3. 竖直滚动条：
  4.         <preference name="vScrollBarEnabled" value="true|false" />

配置启动页是否自动隐藏

字段名：autoLaunch

取值范围：true|false

默认值：true

描述：APICloud应用在启动时向用户展示一个启动界面，并控制该启动界面在适当的时候隐藏。如该字段置为false，则启动页需要开发者自行调相关接口关闭(api.removeLaunchView)。置为true，则引擎自动关闭。默认显示3秒后关闭，如3秒内网页未加载完毕则一直等待，直到网页加载完毕再关闭启动页。

配置示例：

  1. <preference name="autoLaunch" value="true|false" />

配置iOS状态栏和页面是否重合（沉浸式效果）

字段名：iOS7StatusBarAppearance

取值范围：true|false

默认值：true

描述：配置应用界面是否和设备状态栏重合，表现效果为系统的状态栏是否覆盖在当前应用上。若配置了statusBarAppearance字段，此字段将会忽略。

支持iOS7及以上系统。

配置示例：

  1. <preference name="iOS7StatusBarAppearance" value="true" />

配置状态栏和页面是否重合（沉浸式效果）

字段名：statusBarAppearance

取值范围：true|false

默认值：true

描述：配置应用界面是否和设备状态栏重合，表现效果为系统的状态栏是否覆盖在当前应用上，即“沉浸式效果”。

支持iOS7及以上、Android4.4及以上系统。

配置示例：

  1. <preference name="statusBarAppearance" value="true" />

配置应用是否全屏运行

字段名：fullScreen

取值范围：true|false

默认值：false

描述：配置应用是否全屏运行。如果该字段为true，应用将以全屏的方式启动，并以全屏方式运行。运行过程中可随时通过APICloud开放的API（api.setFullScreen）控制退出全屏或重新进入全屏。云编译有效。

配置示例：

  1. <preference name="fullScreen" value="true|false" />

配置应用是否自动检测更新

字段名：autoUpdate

取值范围：true|false

默认值：true

描述：配置应用是否自动检测更新。如果该字段为true，应用在启动时将自动与云端握手，并检查本应用是否有更新，是否被强制关闭，是否强制更新等（以上控制可在云端控制台“版本”中设置）。应用运行过程中会根据这些设置进行相关操作，如：自动下载、强制关闭应用等；若配置为false，则不会弹出任何更新提示。云编译有效。

配置示例：

  1. <preference name="autoUpdate" value="false" />

配置应用是否支持增量更新、云修复

字段名：smartUpdate

取值范围：true|false

默认值：false

描述：配置应用是否支持增量更新以及云修复。如果该字段为true，应用在启动时将自动与云端握手，并检查本应用当前版本下是否有增量包更新，是否需要进行云修复。应用运行过程中会根据这些设置进行相关操作，如：提示更新下载、静默更新下载等。云编译有效。

配置示例：

  1. <preference name="smartUpdate" value="true" />

配置应用开启/关闭调试模式

字段名：debug

取值范围：true|false

默认值：false

描述：配置应用是否处于调试模式。如果该字段为true，标识应用进入调试模式，应用运行过程中发生的因代码书写失误等原因导致的Js报错（引起执行中断）信息，将会以弹窗的方式覆盖在应用最上方，供开发者参考。

配置示例：

  1. <preference name="debug" value="false" />

配置是否允许使用第三方键盘

字段名：allowKeyboardExtension

取值范围：true|false

默认值：true

描述：配置是否允许使用第三方键盘。若不允许，键盘弹出后将不能选择第三方输入法进行输入。只支持iOS，云编译有效。

配置示例：

  1. <preference name="allowKeyboardExtension" value="false" />

配置键盘弹出方式

字段名：softInputMode

取值范围：

  • resize：弹出键盘时会把页面往上推移，iOS平台resize和auto等效;
  • pan：弹出键盘时页面不会被往上推移
  • auto：由系统根据输入框位置决定是否页面往上推移

默认值：auto

描述：配置键盘弹出后页面的处理方式。云编译有效。

配置示例：

  1. <preference name="softInputMode" value="resize"/>

配置是否显示键盘上方的工具条

字段名：softInputBarEnabled

取值范围：true|false

默认值：true

描述：配置是否显示键盘上方的工具条。该配置只对通过api对象方法打开的页面有效。只支持iOS。

配置示例：

  1. <preference name="softInputBarEnabled" value="false" />

配置是否允许页面默认拖拽行为

字段名：dragAndDrop

取值范围：true|false

默认值：false

描述：配置是否允许iOS 11及以上系统中页面元素默认的拖拽行为。只支持iOS。

配置示例：

  1. <preference name="dragAndDrop" value="false" />

配置字体

字段名：font

描述：用于配置字体文件，配置以后在前端页面里面就可以使用该字体。字体文件需放在widget目录里面，可以同时配置多种字体。目前只支持iOS，云编译有效。

配置示例：

  1. //配置一个值：
  2. <preference name="font" value="widget/res/xingkai.ttf" />
  4. //配置多个值，各值之间用竖线 | 隔开：
  5. <preference name="font" value="widget/res/xingkai.ttf | widget/res/lishu.ttf" />

配置后台运行

字段名：backgroundMode

取值范围：

  • audio：在后台播放和录制音频，包括使用AirPlay播放音频、视频流
  • location：在后台持续获取位置信息
  • voip：网络电话
  • newsstand-content：报刊杂志类应用在后台下载内容
  • external-accessory：与定期更新的硬件外设工作
  • bluetooth-central：作为蓝牙中心，与蓝牙外设通信
  • bluetooth-peripheral：作为蓝牙外设，进行蓝牙通信
  • fetch：定期下载少量的内容
  • remote-notification：希望在收到通知后立即去下载相关内容，使相关内容可以尽快显示出来

描述：用于配置iOS后台运行，配置后可以实现后台播放音乐、获取位置信息等功能。云编译有效。

不要随意配置后台运行，因为后台运行的同时也会带来电池续航的问题，苹果公司规定应用使用了后台运行时，必须要在iTunes Connect里应用的描述里面进行声明，否则应用会被拒绝。具体可以参考其他应用如百度地图里面的描述。

配置示例：

  1. //配置一个值：
  2. <preference name="backgroundMode" value="audio"/>
  4. //配置多个值，各值之间用竖线 | 隔开：
  5. <preference name="backgroundMode" value="audio | location"/>

配置URL Scheme

字段名：urlScheme

描述：配置应用的URL Scheme，该scheme用于从浏览器或其他应用中启动本应用，并且可以传递参数数据。此字段云编译有效。

配置后，外部浏览器页面里面就可以通过a标签链接打开应用：

  1. <a href="myscheme://?param1=xxx&param2=xxx">测试打开应用</a>

配置示例：

  1. <preference name="urlScheme" value="myscheme" />

注意：value的值必须是小写，否则将不起作用。

配置可被检测的URL Scheme

字段名：querySchemes

描述：iOS9中对检测应用是否安装的方法做了限制，只允许检测在Info.plist中配置过的LSApplicationQueriesSchemes字段（即白名单列表）里面的应用。所以若代码里面调用了api.appInstalled等方法来检测应用是否安装，那么需要在此字段里面配置被检测应用的URL Scheme才能得到期望的结果。此字段云编译有效。

配置示例：

  1. //多个值之间用英文逗号隔开
  2. <preference name="querySchemes" value="weixin,sinaweibo" />

以下是常用的一些应用的URL Scheme可以参考。

  1.  <key>LSApplicationQueriesSchemes</key>
  2.  <array>
  3.     <!-- 微信 URL Scheme 白名单-->
  4.     <string>wechat</string>
  5.     <string>weixin</string>
  7.     <!-- 新浪微博 URL Scheme 白名单-->
  8.     <string>sinaweibohd</string>
  9.     <string>sinaweibo</string>
  10.     <string>sinaweibosso</string>
  11.     <string>weibosdk</string>
  12.     <string>weibosdk2.5</string>
  14.     <!-- QQ、Qzone URL Scheme 白名单-->
  15.     <string>mqqapi</string>
  16.     <string>mqq</string>
  17.     <string>mqqOpensdkSSoLogin</string>
  18.     <string>mqqconnect</string>
  19.     <string>mqqopensdkdataline</string>
  20.     <string>mqqopensdkgrouptribeshare</string>
  21.     <string>mqqopensdkfriend</string>
  22.     <string>mqqopensdkapi</string>
  23.     <string>mqqopensdkapiV2</string>
  24.     <string>mqqopensdkapiV3</string>
  25.     <string>mqzoneopensdk</string>
  26.     <string>wtloginmqq</string>
  27.     <string>wtloginmqq2</string>
  28.     <string>mqqwpa</string>
  29.     <string>mqzone</string>
  30.     <string>mqzonev2</string>
  31.     <string>mqzoneshare</string>
  32.     <string>wtloginqzone</string>
  33.     <string>mqzonewx</string>
  34.     <string>mqzoneopensdkapiV2</string>
  35.     <string>mqzoneopensdkapi19</string>
  36.     <string>mqzoneopensdkapi</string>
  37.     <string>mqzoneopensdk</string>
  39.     <!-- 支付宝  URL Scheme 白名单-->
  40.     <string>alipay</string>
  41.     <string>alipayshare</string>
  42. </array>

配置网页里被禁止跳转的URL Scheme

字段名：forbiddenSchemes

取值范围：

  • *：禁止页面所有通过URL Scheme跳转到第三方应用的行为
  • scheme：只禁止跳转到该应用。可以配置多个，各个值之间用半角逗号隔开
  • ^scheme：禁止跳转到除该应用外的其它应用。可以配置多个，各个值之间用半角逗号隔开

默认值：不禁止

描述：配置网页里被禁止跳转的URL Scheme。通过配置此字段，可以控制页面里通过a标签等行为能够跳转到哪些第三方应用。此字段不影响api.openApp方法打开第三方应用。

配置示例：

  1. // 禁止所有
  2. <preference name="forbiddenSchemes" value="*" />
  4. // 禁止scheme1和scheme2
  5. <preference name="forbiddenSchemes" value="scheme1,scheme2" />
  7. // 禁止除scheme1和scheme2以外的其它应用
  8. <preference name="forbiddenSchemes" value="^scheme1,^scheme2" />

配置User Agent

字段名：userAgent

描述：用于配置User Agent，配置后会更改页面里的User Agent以及ajax请求的User Agent。云编译有效。

若自定义User Agent里面带有双引号等字符，则需要将内容存于一文本文件里面，并将value配置为该文件的路径，注意该文件必须放在widget目录里面，配置时必须以widget://协议开头，这种方式会替换掉默认的User Agent。

配置示例：

  1. //值为文件路径时，默认的User Agent会被替换成文件中的内容
  2. <preference name="userAgent" value="widget://res/ua.txt" />
  4. //值为普通字符串时，内容会被添加到系统默认User Agent的后面
  5. <preference name="userAgent" value="APICloud" />

配置iTunes文件共享

字段名：fileShare

取值范围：true|false

默认值：false

描述：用于配置是否开启iTunes文件共享，开启后可以通过iTunes或者其它手机助手访问应用的文件目录（苹果已经屏蔽各类手机助手对iOS8.3及以上系统的应用文件目录的访问）。 注意：若需要上传AppStore审核，请不要随意配置此项，除非确实需要文件共享功能，否则会被拒绝。云编译有效，只支持iOS。

配置示例：

  1. <preference name="fileShare" value="false" />

配置自定义下拉刷新模块

字段名：customRefreshHeader

默认值：无

描述：用于配置在页面里面默认使用的自定义下拉刷新模块名称，配置后页面里面可以使用指定的下拉刷新模块来实现各种各样的下拉刷新效果。使用自定义下拉刷新时，页面里面需调用api.setCustomRefreshHeaderInfo方法。

配置示例：

  1. <preference name="customRefreshHeader" value="UIPullRefresh" />

配置是否在桌面显示应用图标

字段名：launcher

取值范围：true|false

默认值：true

描述：仅Android平台有效。用于配置云编译后的应用在安装到用户手机等设备上后，是否在桌面显示应用图标。如果配置为false，应用安装完后将不会在用户手机桌面显示图标，用户无法直接使用，需被第三方应用调起才能使用。该功能通常用于某主应用管理多个子应用的场景。

配置示例：

  1. <preference name="launcher" value="false" />

配置是否检查https证书是受信任的

字段名：checkSslTrusted

取值范围：true|false

默认值：true

描述：用于配置是否检查https证书是受信任的。如果https服务器端证书不是正规机构颁发的，则需要配置false，否则应用将无法访问数据。

配置示例：

  1. <preference name="checkSslTrusted" value="false" />

配置是否校验应用证书

字段名：appCertificateVerify

取值范围：true|false

默认值：true

描述：仅iOS平台有效。用于配置是否校验应用证书。若配置为true，应用被重签名后将无法再使用。

配置示例：

  1. <preference name="appCertificateVerify" value="false" />

配置支持的CPU设备类型

字段名：android_abi

取值范围：arm64-v8a

默认值：空

描述：仅Android平台有效。用于配置APP支持的CPU架构类型。此前，为减小APK安装包大小，云编译默认只保留armeabi的so库。自2019年8月1日起，Google Play要求APK必须包含64位so库，否则将拒绝上线。您的应用可通过配置android_abi字段，支持编译64位so库到APK以适配Google Play政策。

配置示例：

  1. <preference name="android_abi" value="arm64-v8a"/>

配置用户界面风格

字段名：interfaceStyle

取值范围：

  • Automatic：遵循系统设置，当深色模式开启时为深色，关闭时为浅色
  • Light：忽略系统设置，始终为浅色模式
  • Dark：忽略系统设置，始终为深色模式

默认值：Light

描述：仅支持iOS 13及以上系统，云编译生效。用于全局配置当前应用程序的用户界面风格。

配置示例：

  1. <preference name="interfaceStyle" value="Automatic"/>

配置是否使用WKWebView

字段名：useWKWebView

取值范围：true|false

默认值：false

描述：若配置为true，加载页面时将默认使用WKWebView。参考WKWebView介绍

配置示例：

  1. <preference name="useWKWebView" value="true"/>

配置WKWebView页面恢复模式

字段名：WKWebViewRecoveryMode

取值范围：

  1. reload        // 重新刷新白屏的页面。可通过api.isRecoveryMode属性判断是否是恢复模式。
  2. rebootApp     // 热重启应用
  3. none          // 不做处理

默认值：reload

描述：WKWebView加载的页面的渲染进程是独立于当前App的，当系统内存不足时，系统可能会结束掉该进程进行回收，从而导致该页面白屏。可通过配置此字段来刷新页面或热重启整个应用，该配置只当应用在前台运行时有效，若应用在后台时有页面白屏，则回到前台时会直接进行热重启。

配置示例：

  1. <preference name="WKWebViewRecoveryMode" value="rebootApp"/>

Feature

Feature用于声明本应用使用到的平台扩展模块功能、第三方SDK等接入规范、运行时组件，并声明该模块默认需要传入的参数及值（param），每个Feature对应一个或多个参数值。APICloud应用通过这些模块为用户提供特定的功能。

属性：

name：模块名称。

forceBind：表示是否强制绑定模块，为true时在网站上面该模块会被自动勾选上且不能去掉，默认值为true。

platform：配置云编译时使用该模块的平台，取值范围all、ios、android，默认值为all。例如应用里面有虚拟类商品时，安卓平台可以使用支付宝、微信等第三方支付模块，而iOS要上架AppStore则必须使用苹果内购，并且安装包内也不能包含支付宝、微信支付等资源。此时则可以配置支付宝、微信支付模块对应feature的platform字段值为android，这样云编译iOS包时不会将支付宝、微信支付模块编译进去。

配置示例：

  1. <feature name="moduleName" forceBind="false" platform="all">
  2.     <param name="xxx" value="xxx" />
  3. </feature>

微信

名称：weiXin

参数：urlScheme

描述：配置微信专用的URL Scheme，使得本应用可以启动微信客户端，并与之交换数据，同时可以从微信客户端返回到本应用

配置示例：

  1. <feature name="weiXin">
  2.     <param name="urlScheme" value="wx7779c7c063a9d4d9" />
  3.     <param name="apiKey" value="wx7779c7c063a9d4d9" />
  4.     <param name="apiSecret" value="a354f72aa1b4c2b8eaad137ac81434cd" />
  5. </feature>

字段描述：

  1. param-urlScheme：声明此字段为URL Scheme类型
  2. param-value：对应urlScheme类型的值。通过微信开放平台申请。用于从当前应用跳到微信后能够回到当前应用。
  3. param-apiKey：在微信开放平台申请的apiKey，使用微信的开放接口，必须申请该key。
  4. param-value：在微信开放平台申请的apiKey的值。

新浪微博

名称：sinaWeiBo

参数：urlScheme

描述：配置新浪微博专用的URL Scheme，以及apiKey，使得本应用可以启动新浪微博客户端，并与之交换数据，同时可以从新浪微博客户端返回到本应用

配置示例：

  1. <feature name="sinaWeiBo">
  2.     <param name="urlScheme" value="wb1464272715" />
  3.     <param name="apiKey" value="1464272715" />
  4. </feature>

字段描述：

  1. param-urlScheme：声明此字段为URL Scheme类型
  2. param-value：对应urlScheme类型的值。通过新浪微博开放平台申请apiKey，再加上‘wb’前缀构成
  3. param-apiKey：在新浪微博开放平台申请的apiKey，使用新浪微博的开放接口，必须申请该key。
  4. param-value：在新浪微博开放平台申请的apiKey的值。
  5. param-apiSecret: 通过微信开放平台申请的应用秘钥
  6. param-value: 此参数用于微信登录授权获取登录的accessToken

百度定位

名称：baiduLocation

参数：apiKey

描述：配置百度定位功能必须的apiKey，该key需要在百度开放平台申请，申请细则请参考百度开放平台相关文档。

配置示例：

  1. <feature name="baiduLocation">
  2.     <param name="apiKey" value="fef72715gshjelke" />
  3. </feature>

字段描述：

  1. param-apiKey：声明此字段为apiKey类型
  2. param-value：对应apiKey类型的值。在百度开放平台申请的apiKey

百度地图

名称：baiduMap

参数：apiKey

描述：配置百度地图模块必须的apiKey，该key需要在百度开放平台申请，申请细则请参考百度开放平台相关文档。

配置示例：

  1. <feature name="baiduMap">
  2.     <param name="android_api_key" value="fef72715gshjelke" />
  3.     <param name="ios_api_key" value="fef72715gshjelke" />
  4. </feature>

字段描述：

  1. param-apiKey：声明此字段为apiKey类型
  2. param-value：对应apiKey类型的值。在百度开放平台申请的apikey，iOS和android需要分别申请，并同时配入config文件中。

支付宝支付

名称：aliPay

参数：urlScheme

描述：配置支付宝专用的URL Scheme，使得本应用可以启动支付宝客户端，并与之交换数据，同时可以从支付宝客户端返回到本应用

配置示例：

  1. <feature name="aliPay">
  2.     <param name="urlScheme" value="AliPay + widgetId" />
  3. </feature>

字段描述：

  • param-urlScheme：声明此字段为URL Scheme类型
  • param-value：固定值，由字符串‘AliPay’和本应用的widgetId拼接而成。

QQ登录/分享

名称：qq

参数：urlScheme

描述：配置qq专用的URL Scheme，以及apiKey，使得本应用可以启动QQ客户端，并与之交换数据，同时可以从QQ客户端返回到本应用

配置示例：

  1. <feature name="qq">
  2.     <param name="urlScheme" value="tencent123345678" />
  3.     <param name="apiKey" value="123345678" />
  4. </feature>

字段描述：

  1. param-urlScheme：声明此字段为URL Scheme类型
  2. param-value：对应urlScheme类型的值。由腾讯开放平台申请的apiKey和tencent前缀构成：tencent + apiKey。
  3. param-apiKey：在腾讯开放平台申请的apiKey，使用腾讯的开放接口，必须申请该apiKey。
  4. param-value：在腾讯开放平台申请的apiKey的值。

极光推送

名称：ajpush

参数：channel、app_key

描述：配置使用极光推送所需的app_key以及统计用的渠道号，app_key需要在极光推送官网申请，channel用于极光官网统计分发渠道

配置示例：

  1. <feature name="ajpush">
  2.     <param name="channel" value="developer-apicloud" />
  3.     <param name="app_key" value="2878d6d8bc2556b577a53e05" />
  4. </feature>

字段描述：

  1. param-channel：渠道号
  2. param-value：渠道号值，任意自定义的字符串，字母+数字。默认为：developer-apicloud
  3. param-app_key：在极光推送官网申请的appKey。不可为空。
  4. param-value：appKey值。

融云即时通讯

名称：rongCloud

参数：appKey

描述：配置融云开发者平台上申请的 App Key 值

配置示例：

  1. <feature name="rongCloud">
  2.     <param name="appKey" value="此处填写App Key 值" />
  3. </feature>

Permission

Permission用于声明本应用用到的所有系统权限。APICloud开放的API接口以及提供的服务或者功能中，可能需要向操作系统申请某些权限，APICloud将这些权限归类并抽象后提供给开发者，开发者通过简单的字段声明，APICloud云端在编译应用时，将会判别permission字段并给应用安装包添加相应的系统权限（即应用安装时，系统向用户展示的权限列表）。

读取手机状态和身份

权限名称：readPhoneState

权限描述：允许该应用访问设备的电话功能。此权限可以让该应用确定本机号码和设备ID、是否处于通话状态以及拨打的号码

使用该权限的接口：api.ajax()、api.download()、api.getLocation()

是否敏感：否

配置示例：<permission name="readPhoneState" />

直接拨打电话

权限名称：call

权限描述：允许应用在用户未执行操作的情况下直接拨打电话号码。此权限可能会导致意外收费或呼叫。此权限不允许该应用拨打紧急电话号码。

使用该权限的接口：api.call()

是否敏感：是

配置示例：<permission name="call" />

直接发送短信

权限名称：sms

权限描述：允许该应用在用户不知情的情况下直接发送短信。此权限可能会导致意外收费。

使用该权限的接口：api.sms()

是否敏感：是

配置示例：<permission name="sms" />

使用拍照和视频

权限名称：camera

权限描述：允许该应用使用相机拍摄照片和视频。此权限可以让应用随时使用相机，而无需用户确认。

使用该权限的接口：api.getPicture()

是否敏感：否

配置示例：<permission name="camera" />

使用录音

权限名称：record

权限描述：允许该应用访问设备的麦克风，并进行录音。该权限可能导致用户隐私的泄露。

使用该权限的接口：api.startRecord()

是否敏感：否

配置示例：<permission name="record" />

访问地理位置信息

权限名称：location

权限描述：允许该应用访问位置提供程序根据GPS、基站和WLAN等网络源确定用户的的大概或者精确位置，当这些位置服务可用且处于启用状态时，此权限可让该应用确定用户的位置。使用该类服务时，用户的设备也会消耗更多的电量。

使用该权限的接口：api.startLocation()、api.getLocation()

是否敏感：是

配置示例：<permission name="location" />

访问文件系统

权限名称：fileSystem

权限描述：允许应用读取或写入内部存储及外部SD卡。

使用该权限的接口：api.readFile()、api.writeFile()、api.startRecord()、api.getPicture()

是否敏感：否

配置示例：<permission name="fileSystem" />

完全的访问网络权限

权限名称：internet

权限描述：允许应用创建网络套接字和使用自定义网络协议。查看网络连接的相关信息，查看WLAN状态、更改WLAN状态，更改网络设置，访问设备WIFI信息等。

使用该权限的接口：api.ajax()、api.download()、api.startLocation()、api.getLocation()

是否敏感：否

配置示例：<permission name="internet" />

开机启动

权限名称：bootCompleted

权限描述：允许该应用在系统启动完成后立即自动启动。这可能会导致延长手机的启动时间，并允许应用始终运行，从而导致手机总体运行速度减慢。

使用该权限的接口：基于推送的相关服务

是否敏感：否

配置示例：<permission name="bootCompleted" />

控制振动/闪光灯/屏幕休眠等硬件设备

权限名称：hardware

权限描述：允许应用控制闪光灯、振动器、防止手机休眠等。

使用该权限的接口：api.getPicture()、基于推送的相关服务

是否敏感：否

配置示例：<permission name="hardware" />

访问设备通讯录

权限名称：contact

权限描述：允许该应用访问和修改用户手机上存储的联系人的相关数据。

使用该权限的接口：api.openContacts()

是否敏感：是

配置示例：<permission name="contact" />

Meta-Data

meta-data用于配置Android平台上对应AndroidManifest文件中的meta-data相关键值对。

在config中每配置一项，云编译服务器在编译apk包之前，会将meta-data相关的配置，映射到AndroidManifest文件中的meta-data节点中。如：我们在config中配置，将映射至Android平台的AndroidManifest中为：<meta-data android:name="kkkk" android:value="vvvv" />以此类推。

该配置一般用于引入第三方服务的SDK模块时，配置相应模块所需的meta-data。也可用于配置渠道号等。

配置示例：

  1. <meta-data name="KKKK" value="VVVV"/>

字段描述：

  1. name：声明meta-data键值对中的键名
  2. value：声明meta-data键值对中对应的值

Intent-Filter

该配置使用时需要Android原生开发人员参与。

intent-filter用于配置Android平台相应的AndroidManifest文件中，APICloud引擎主Activity的intent-filter相关信息。

在config中每配置一项，云编译服务器在编译apk包之前，会将intent-filter相关的配置，新增并映射到AndroidManifest文件中，引擎主Activity的intent-filter节点。如：我们在config中配置：

  1. <intent-filter>
  2.     <action name="android.intent.action.MAIN"/>
  3.     <category name="android.intent.category.DEFAULT"/>
  4.     <data scheme="http" mimeType="text/html"/>
  5. </intent-filter>

将映射至Android平台的AndroidManifest中引擎主Activity的intent-filter，类似：

  1. <activity android:name="com.uzmap.pkg.EntranceActivity">
  2.     <intent-filter>
  3.         <action android:name="android.intent.action.MAIN" />
  4.         <category android:name="android.intent.category.DEFAULT" />
  5.         <data android:scheme="http" android:mimeType="text/html"/>
  6.     </intent-filter>
  7. </activity>

config中每配置一项intent-filter，该节点下新增一项intent-filter。

该配置一般用于配置本应用被其他应用调起时的响应类型，比如响应一个“打开”的操作，或者一个“发送”的操作等。

配置示例：

  1. <intent-filter>
  2.     <action name="android.intent.action.MAIN"/>
  3.     <category name="android.intent.category.DEFAULT" />
  4.     <category name="com.ibm.apicloud.open"/>
  5.     <data scheme="http" mimeType="text/html" host="baidu" path="/" />
  6. </intent-filter>

字段描述：

  1. action：声明intent-filter响应的动作，同Android平台的action。（必须字段）
  2. category：声明intent-filter响应的范围或类别，同Android平台的category（可选字段）
  3. data：声明intent-filter响应的数据类型，同Android平台的data（可选字段） 3.1. scheme：data对应的协议头（可选字段） 3.2. mimeType：data对应的mimeType（可选字段） 3.3. host：data对应的主机地址（可选字段） 3.4. path：data对应的路径（可选字段）

Reference

完整的config文件参考：

  1. <widget id="A12345678901"  version="0.0.1">
  2.     <name>API Example</name>
  3.     <description>
  4.         API Example App.
  5.     </description>
  6.     <author email="developer@apicloud.com" href="//www.apicloud.com">
  7.         APICloud.SIR
  8.     </author>
  9.     <content src="index.html" />
  10.     <access origin="*" />
  11.     <preference name="pageBounce" value="false" />
  12.     <preference name="appBackground" value="#000" />
  13.     <preference name="windowBackground" value="rgba(0,0,0,0.0)" />
  14.     <preference name="frameBackgroundColor" value="rgba(0,0,0,0.0)" />
  15.     <preference name="hScrollBarEnabled" value="true" />
  16.     <preference name="vScrollBarEnabled" value="true" />
  17.     <preference name="autoLaunch" value="true" />
  18.     <preference name="autoUpdate" value="true" />
  19.     <preference name="smartUpdate" value="false" />
  20.     <preference name="fullScreen" value="false" />
  21.     <preference name="statusBarAppearance" value="true" />
  22.     <preference name="softInputMode" value="resize"/>
  23.     <preference name="debug" value="true"/>
  24.     <permission name="readPhoneState" />
  25.     <permission name="call" />
  26.     <permission name="sms" />
  27.     <permission name="camera" />
  28.     <permission name="record" />
  29.     <permission name="location" />
  30.     <permission name="fileSystem" />
  31.     <permission name="internet" />
  32.     <permission name="bootCompleted" />
  33.     <permission name="hardware" />
  34.     <permission name="contact" />
  35.     <feature name="weiXin">
  36.         <param name="urlScheme" value="wx7779c7c063a9d4d9" />
  37.         <param name="apiKey" value="wx7779c7c063a9d4d9" />
  38.     </feature>
  39.     <feature name="sinaWeiBo">
  40.         <param name="urlScheme" value="wb1062272715" />
  41.         <param name="apiKey" value="1062272715" />
  42.     </feature>
  43.     <feature name="aliPay">
  44.          <param name="urlScheme" value="AliPayA00000000001" />
  45.     </feature>
  46.     <feature name="baiduLocation">
  47.         <param name="apiKey" value="fef72715gshjelke" />
  48.     </feature>
  49.     <feature name="baiduMap">
  50.         <param name="android_api_key" value="fef72715gshjelke" />
  51.         <param name="ios_api_key" value="fef72715gshjelke" />
  52.     </feature>
  53.     <feature name="qq">
  54.         <param name="urlScheme" value="tencent9c7c063a9d4d9" />
  55.         <param name="apiKey" value="9c7c063a9d4d9" />
  56.     </feature>
  57. </widget>