ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

config.json元素含义速查

2021-08-05 11:04:06  阅读:414  来源: 互联网

标签:表示 Ability 卡片 标签 json 应用 速查 config 取值


  • app : 表示应用的全局配置信息。同一个应用的不同HAP包的app配置必须保持一致。

    • bundleName : 表示应用的包名,用于标识应用的唯一性。
    • vendor : 表示对应用开发厂商的描述。字符串长度不超过255字节。
    • version : 表示应用的版本信息。
      • name : 表示应用的版本号,用于向应用的终端用户呈现。取值可以自定义,长度不超过127个字节。
      • code : 表示应用的版本号,仅用于HarmonyOS管理该应用,不对应用的终端用户呈现。
      • minCompatibleVersionCode : 表示应用可兼容的最低版本号,用于在跨设备场景下,判断其他设备上该应用的版本是否兼容。格式与version.code字段的格式要求相同。
    • apiVersion : 表示应用依赖的HarmonyOS的API版本。
      • compatible : 表示应用运行需要的API最小版本。取值为大于零的整数。
      • target : 表示应用运行需要的API目标版本。取值为大于零的整数。
      • releaseType : 表示应用运行需要的API目标版本的类型。取值为“CanaryN”、“BetaN”或者“Release”。
    • multiFrameworkBundle : 表示应用是否为混合打包的HarmonyOS应用。
    • smartWindowSize : 该标签用于在悬浮窗场景下表示应用的模拟窗口的尺寸。
    • smartWindowDeviceType : 表示应用可以在哪些设备上使用模拟窗口打开。取值为:智能手机:phone、平板:tablet、智慧屏:tv。
    • targetBundleList : 表示允许以免安装方式拉起的其他HarmonyOS应用,列表取值为每个HarmonyOS应用的bundleName,多 个bundleName之间用英文“,”区分,最多配置10个bundleName。如果被拉起的应用不支持免安装方式,则拉起失败。
  • deviceConfig : 表示应用在具体设备上的配置信息。

    • default : 表示所有设备通用的应用配置信息。

      • jointUserId : 表示应用的共享userid。

        通常情况下,不同的应用运行在不同的进程中,应用的资源是无法共享。如果开发者的多个应用之间需要共享资源,则可以通过相同的jointUserId值实现,前提是这些应用的签名相同。

        该标签仅对系统应用生效,且仅适用于手机、平板、智慧屏、车机、智能穿戴。

        该字段在API Version 3及更高版本不再支持配置。

      • process : 表示应用或者Ability的进程名。

        如果在deviceConfig标签下配置了process标签,则该应用的所有Ability都运行在这个进程中。 如果在abilities标签下也为某个Ability配置了process标签,则该Ability就运行在这个进程中。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • supportBackup : 表示应用是否支持备份和恢复。如果配置为“false”,则不支持为该应用执行备份或恢复操作。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • compressNativeLibs : 表示libs库是否以压缩存储的方式打包到HAP包。如果配置为“false”,则libs库以不压缩的方式存储,HAP包在安装时无需解压libs,运行时会直接从HAP内加载libs库。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • network : 表示网络安全性配置。该标签允许应用通过配置文件的安全声明来自定义其网络安全,无需修改应用代码。

        • cleartextTraffic : 表示是否允许应用使用明文网络流量(例如,明文HTTP)。
        • securityConfig : 表示应用的网络安全配置信息。
          • domainSettings : 表示自定义的网域范围的安全配置,支持多层嵌套,即一个domainSettings对象中允许嵌套更小网域范围的domainSettings对象。
            • cleartextPermitted : 表示自定义的网域范围内是否允许明文流量传输。当cleartextTraffic和securityConfig同时存在时,自定义网域是否允许明文流量传输以cleartextPermitted的取值为准。
            • domains : 表示域名配置信息,包含两个参数:subdomains和name。
              • subdomains (布尔类型): 表示是否包含子域名。如果为 “true”,此网域规则将与相应网域及所有子网域(包括子网域的子网域)匹配。否则,该规则仅适用于精确匹配项。
              • name(字符串):表示域名名称。
    • phone : 表示手机类设备的应用信息配置。

    • tablet : 表示平板的应用配置信息。

    • tv : 表示智慧屏特有的应用配置信息。

    • car : 表示车机特有的应用配置信息。

    • wearable : 表示智能穿戴特有的应用配置信息。

    • liteWearable : 表示轻量级智能穿戴特有的应用配置信息。

    • smartVision : 表示智能摄像头特有的应用配置信息。

  • module : 表示HAP包的配置信息。该标签下的配置只对当前HAP包生效。

    • mainAbility : 表示HAP包的入口ability名称。该标签的值应配置为“module > abilities”中存在的Page类型ability的名称。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • package : 表示HAP的包结构名称,在应用内应保证唯一性。采用反向域名格式(建议与HAP的工程目录保持一致)。字符串长度不超过127字节。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • name : 表示HAP的类名。采用反向域名方式表示,前缀需要与同级的package标签指定的包名一致,也可采用“.”开头的命名方式。字符串长度不超过255字节。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • description : 表示HAP的描述信息。字符串长度不超过255字节。如果字符串超出长度或者需要支持多语言,可以采用资源索引的方式添加描述内容。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • supportedModes : 表示应用支持的运行模式。当前只定义了驾驶模式(drive)。

      该标签仅适用于车机。

    • deviceType : 表示允许Ability运行的设备类型。系统预定义的设备类型包括:phone(手机)、tablet(平板)、tv(智慧屏)、car(车机)、wearable(智能穿戴)、liteWearable(轻量级智能穿戴)等。

    • distro : 表示HAP发布的具体描述。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • deliveryWithInstall : 表示当前HAP是否支持随应用安装。
      • moduleName : 表示当前HAP的名称。
      • moduleType : 表示当前HAP的类型,包括两种类型:entryfeature
      • installationFree : 表示当前该FA是否支持免安装特性。
    • metaData : 表示HAP的元信息。

      • parameters : 表示调用Ability时所有调用参数的元信息。
        • description : 表示对调用参数的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。
        • name : 表示调用参数的名称。
        • type : 表示调用参数的类型,如Integer。
      • results : 表示Ability返回值的元信息。
        • description : 表示对返回值的描述,可以是表示描述内容的字符串,也可以是对描述内容的资源索引以支持多语言。
        • name : 表示返回值的名字。
        • type : 表示返回值的类型,如Integer。
      • customizeData : 表示父级组件的自定义元信息,parameters和results在module中不可配。
        • name : 表示数据项的键名称,字符串类型(最大长度255字节)。
        • value : 表示数据项的值,字符串类型(最大长度255字节)。
        • extra : 表示用户自定义数据格式,标签值为标识该数据的资源的索引值。
    • abilities : 表示当前模块内的所有Ability。采用对象数组格式,其中每个元素表示一个Ability对象。

      • name : 表示Ability名称。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • description : 表示对Ability的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。

      • icon : 表示Ability图标资源文件的索引。如果在该Ability的skills属性中,actions的取值包含 “action.system.home”,entities取值中包含“entity.system.home”,则该Ability的icon将同时作为应用的icon。如果存在多个符合条件的Ability,则取位置靠前的Ability的icon作为应用的icon。

      • label : 表示Ability对用户显示的名称。取值可以是Ability名称,也可以是对该名称的资源索引,以支持多语言。如果在该Ability的skills属性中,actions的取值包含 “action.system.home”,entities取值中包含“entity.system.home”,则该Ability的label将同时作为应用的label。如果存在多个符合条件的Ability,则取位置靠前的Ability的label作为应用的label。

      • uri : 表示Ability的统一资源标识符。格式为[scheme:][//authority][path][?query][#fragment]。

      • launchType : 表示Ability的启动模式,支持“standard”、“singleMission”和“singleton”三种模式:

        ​ standard:表示该Ability可以有多实例。“standard”模式适用于大多数应用场景。

        ​ singleMission:表示此Ability在每个任务栈中只能有一个实例。

        ​ singleton:表示该Ability在所有任务栈中仅可以有一个实例。例如,具有全局唯一性的呼叫来电界面即采用“singleton”模式。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • visible : 表示Ability是否可以被其他应用调用。

      • permissions : 表示其他应用的Ability调用此Ability时需要申请的权限。通常采用反向域名格式,取值可以是系统预定义的权限,也可以是开发者自定义的权限。如果是自定义权限,取值必须与defPermissions标签中定义的某个权限的name标签值一致。

      • skills : 表示Ability能够接收的Intent的特征。

        • actions : 表示能够接收的Intent的action值,可以包含一个或多个action。
        • entities : 表示能够接收的Intent的Ability的类别(如视频、桌面应用等),可以包含一个或多个entity。
        • uris : 表示能够接收的Intent的uri,可以包含一个或者多个uri。
          • scheme : 表示uri的scheme值。
          • host : 表示uri的host值。
          • port : 表示uri的port值。
          • path : 表示uri的path值。
          • type : 表示uri的type值。
      • deviceCapability : 表示Ability运行时要求设备具有的能力,采用字符串数组的格式表示。

      • metaData : 表示Ability的元信息。

        ​ 调用Ability时调用参数的元信息,例如:参数个数和类型。

        ​ Ability执行完毕返回值的元信息,例如:返回值个数和类型。

        该标签仅适用于智慧屏、智能穿戴、车机。

      • type : 表示Ability的类型。取值范围如下:

        ​ page:表示基于Page模板开发的FA,用于提供与用户交互的能力。

        ​ service:表示基于Service模板开发的PA,用于提供后台运行任务的能力。

        ​ data:表示基于Data模板开发的PA,用于对外部提供统一的数据访问抽象。

        ​ CA:表示支持其他应用以窗口方式调起该Ability。

      • orientation : 表示该Ability的显示模式。该标签仅适用于page类型的Ability。取值范围如下:

        ​ unspecified:由系统自动判断显示方向。

        ​ landscape:横屏模式。

        ​ portrait:竖屏模式。

        ​ followRecent:跟随栈中最近的应用。

      • backgroundModes : 表示后台服务的类型,可以为一个服务配置多个后台服务类型。该标签仅适用于service类型的Ability。取值范围如下:

        ​ dataTransfer:通过网络/对端设备进行数据下载、备份、分享、传输等业务。

        ​ audioPlayback:音频输出业务。

        ​ audioRecording:音频输入业务。

        ​ pictureInPicture:画中画、小窗口播放视频业务。

        ​ voip:音视频电话、VOIP业务。

        ​ location:定位、导航业务。

        ​ bluetoothInteraction:蓝牙扫描、连接、传输业务。

        ​ wifiInteraction:WLAN扫描、连接、传输业务。

        ​ screenFetch:录屏、截屏业务。

        ​ multiDeviceConnection:多设备互联业务

      • readPermission : 表示读取Ability的数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • writePermission : 表示向Ability写数据所需的权限。该标签仅适用于data类型的Ability。取值为长度不超过255字节的字符串。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • configChanges : 表示Ability关注的系统配置集合。当已关注的配置发生变更后,Ability会收到onConfigurationUpdated回调。取值范围:

        ​ locale:表示语言区域发生变更。

        ​ layout:表示屏幕布局发生变更。

        ​ fontSize:表示字号发生变更。

        ​ orientation:表示屏幕方向发生变更。

        ​ density:表示显示密度发生变更。

      • mission : 表示Ability指定的任务栈。该标签仅适用于page类型的Ability。默认情况下应用中所有Ability同属一个任务栈。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • targetAbility : 表示当前Ability重用的目标Ability。该标签仅适用于page类型的Ability。如果配置了targetAbility属性,则当前Ability(即别名Ability)的属性中仅name、icon、label、visible、permissions、skills生效,其它属性均沿用targetAbility中的属性值。目标Ability必须与别名Ability在同一应用中,且在配置文件中目标Ability必须在别名之前进行声明。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • multiUserShared : 表示Ability是否支持多用户状态进行共享,该标签仅适用于data类型的Ability。

        配置为“true”时,表示在多用户下只有一份存储数据。需要注意的是,该属性会使visible属性失效。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • supportPipMode : 表示Ability是否支持用户进入PIP模式(用于在页面最上层悬浮小窗口,俗称“画中画”,常见于视频播放等场景)。该标签仅适用于page类型的Ability。

        该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

      • formsEnabled : 表示Ability是否支持卡片(forms)功能。该标签仅适用于page类型的Ability。

      • forms : 表示服务卡片的属性。该标签仅当formsEnabled为“true”时,才能生效。

        • name : 表示卡片的类名。字符串最大长度为127字节。

        • description : 表示卡片的描述。取值可以是描述性内容,也可以是对描述性内容的资源索引,以支持多语言。字符串最大长度为255字节。

        • isDefault : 表示该卡片是否为默认卡片,每个Ability有且只有一个默认卡片。

        • type :表示卡片的类型。取值范围如下:

          ​ Java:Java卡片。

          ​ JS:JS卡片。

        • colorMode : 表示卡片的主题样式,取值范围如下:

          ​ auto:自适应。

          ​ dark:深色主题。

          ​ light:浅色主题。

        • supportDimensions : 表示卡片支持的外观规格,取值范围:

          ​ 1*2:表示1行2列的二宫格。

          ​ 2*2:表示2行2列的四宫格。

          ​ 2*4:表示2行4列的八宫格。

          ​ 4*4:表示4行4列的十六宫格。

        • defaultDimension : 表示卡片的默认外观规格,取值必须在该卡片supportDimensions配置的列表中。

        • landscapeLayouts : 表示卡片外观规格对应的横向布局文件,与supportDimensions中的规格一一对应。仅当卡片类型为Java卡片时,需要配置该标签。

        • portraitLayouts : 表示卡片外观规格对应的竖向布局文件,与supportDimensions中的规格一一对应。仅当卡片类型为Java卡片时,需要配置该标签。

        • updateEnabled : 示卡片是否支持周期性刷新,取值范围:

          ​ true:表示支持周期性刷新,可以在定时刷新(updateDuration)和定点刷新(scheduledUpdateTime)两种方式任选其一,优先选择定时刷新。

          ​ false:表示不支持周期性刷新。

        • scheduledUpdateTime : 表示卡片的定点刷新的时刻,采用24小时制,精确到分钟。

        • updateDuration : 表示卡片定时刷新的更新周期,单位为30分钟,取值为自然数。

          ​ 当取值为0时,表示该参数不生效。

          ​ 当取值为正整数N时,表示刷新周期为30*N分钟。

        • formConfigAbility : 表示卡片的配置跳转链接,采用URI格式。

        • jsComponentName : 表示JS卡片的Component名称。字符串最大长度为127字节。仅当卡片类型为JS卡片时,需要配置该标签。

        • metaData : 表示卡片的自定义信息,包含customizeData数组标签。

        • customizeData : 表示自定义的卡片信息。

          • name : 表示数据项的键名称。字符串最大长度为255字节。
          • value : 表示数据项的值。字符串最大长度为255字节。
      • resizeable : 表示Ability是否支持多窗口特性。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • js : 表示基于JS UI框架开发的JS模块集合,其中的每个元素代表一个JS模块的信息。

      • name : 表示JS Component的名字。该标签不可缺省,默认值为default。

      • pages : 表示JS Component的页面用于列举JS Component中每个页面的路由信息[页面路径+页面名称]。该标签不可缺省,取值为数组,数组第一个元素代表JS FA首页。

      • window : 用于定义与显示窗口相关的配置。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

        • designWidth : 表示页面设计基准宽度。以此为基准,根据实际设备宽度来缩放元素大小。
        • autoDesignWidth : 表示页面设计基准宽度是否自动计算。当配置为true时,designWidth将会被忽略,设计基准宽度由设备宽度与屏幕密度计算得出。
      • type : 表示JS应用的类型。取值范围如下:

        ​ normal:标识该JS Component为应用实例。

        ​ form:标识该JS Component为卡片实例。

    • shortcuts : 表示应用的快捷方式信息。采用对象数组格式,其中的每个元素表示一个快捷方式对象。

      • shortcutId : 表示快捷方式的ID。字符串的最大长度为63字节。
      • label : 表示快捷方式的标签信息,即快捷方式对外显示的文字描述信息。取值可以是描述性内容,也可以是标识label的资源索引。字符串最大长度为63字节。
      • intents : 表示快捷方式内定义的目标intent信息集合,每个intent可配置两个子标签,targetClass, targetBundle。
        • targetClass : 表示快捷方式目标类名。
        • targetBundle : 表示快捷方式目标Ability所在应用的包名。
    • defPermissions : 表示应用定义的权限。应用调用者必须申请这些权限,才能正常调用该应用。

    • reqPermissions : 表示应用运行时向系统申请的权限。

    • colorMode : 表示应用自身的颜色模式。

      ​ dark:表示按照深色模式选取资源。

      ​ light:表示按照浅色模式选取资源。

      ​ auto:表示跟随系统的颜色模式值选取资源。

      该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

    • resizeable : 表示应用是否支持多窗口特性。该标签仅适用于手机、平板、智慧屏、车机、智能穿戴。

具体使用详见 https://developer.harmonyos.com/cn/docs/documentation/doc-guides/basic-config-file-elements-0000000000034463

标签:表示,Ability,卡片,标签,json,应用,速查,config,取值
来源: https://www.cnblogs.com/pensieve/p/15102342.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有