APICloud的config.xml应用配置的说明



一．APICloud的config.xml应用配置的说明

每一个Widget 包必须有一个名为 config.xml （大小写敏感）的配

置文件，它位于Widget包的根目录下。该配置文件包含了关于该Widget的重要信息，如：名称、作者信息、描述、云端ID、偏好设置、权限配置、模块概览等等，并且该配置文件也是整个Widget的入口。

以下是整个配置文件：

 

 

配置清单描述：

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

• 表1. widget父元素的属性

属性名

描述

备注

id

应用ID，由云服务器自动分配。它是该Widget在云端的唯一标识。云服务器根据此ID对Widget进行管理并提供辅助服务，如：更新升级、统计分析、推送服务等。

必选

version

Widget的版本号

必选

sandbox

配置此属性后，APICloud应用在运行之初，将会在设备的SD卡上建立与此属性同名的文件夹根目录，并将该目录默认为本应用的沙箱根路径，此后应用运行过程中所有涉及的文件操作如：文件读写，拍照、下载等等，操作结果的文件都将存放在该路径下。该属性仅Android平台生效

可选

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

• 表2. Widget配置元素

元素名

描述

备注

name

Widget的名称。如：QQ、新浪微博、微信等

必选

description

Widget的简单描述信息

可选

author

Widget的作者信息

可选

content

Widget运行的起始页，支持相对/绝对路径

必选

access

在哪些页面里面可以访问APICloud的扩展API。一般配置“*”，代表所有页面都允许访问

可选

preference

偏好设置。配置Widget的一些运行时属性，如：页面是否支持弹动效果、窗口默认背景、页面是否显示滚动条等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Preference Guide

可选

permission

权限配置。通过此配置向系统声明Widget所用到的系统权限。如：直接拨打电话、直接发送短信、发起定位等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Platform Permission

必选

feature

功能配置。通过此配置，向系统声明需要使用哪些功能，以及需要传递给该功能的数据。如：使用新浪微博、使用微信分享等。该配置可在APICloud Studio的GUI界面中选择并使用。详细请参考Feature Guide

可选

font

字体配置。通过此配置，将自定义字体加入到应用中，使其可以在前端页面使用该字体

可选

Preference

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

Feature

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

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

Permission

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

关于配置文件的属性详情浏览 http://docs.apicloud.com/Dev-Guide/app-config-manual 。