Internal Structure of the module Tag

The module tag contains the HAP configuration.

Table 1 Internal structure of the module tag

Example of the module tag structure:

{
  "module": {
    "mainAbility": ".EntryAbility",
    "deviceType": [
      "default",
      "tablet"
    ],
    "abilities": [
      {
        "skills": [
          {
            "entities": [
              "entity.system.home"
            ],
            "actions": [
              "action.system.home"
            ]
          }
        ],
        "orientation": "unspecified",
        "visible": true,
        "srcPath": "EntryAbility",
        "name": ".EntryAbility",
        "srcLanguage": "ets",
        "icon": "$media:icon",
        "description": "$string:MainAbility_desc",
        "formsEnabled": false,
        "label": "$string:MainAbility_label",
        "type": "page",
        "launchType": "standard"
      }
    ],
    "distro": {
      "moduleType": "entry",
      "installationFree": false,
      "deliveryWithInstall": true,
      "moduleName": "entry"
    },
    "package": "com.example.entry",
    "srcPath": "",
    "name": ".entry",
    "js": [
      {
        "mode": {
          "syntax": "ets",
          "type": "pageAbility"
        },
        "pages": [
          "pages/Index"
        ],
        "name": ".EntryAbility",
        "window": {
          "designWidth": 720,
          "autoDesignWidth": false
        }
      }
    ]
  }
}

Internal Structure of the distro Attribute

Table 2 Internal structure of the distro attribute

Example of the distro attribute structure:

"distro": {
  "moduleName": "ohos_entry",
  "moduleType": "entry",
  "installationFree": true,
  "deliveryWithInstall": true
}

Internal Structure of the metadata Attribute

Table 3 Internal structure of the metadata attribute

Internal Structure of the parameters Attribute

Table 4 Internal structure of the parameters attribute

Internal Structure of the results Attribute

Table 5 Internal structure of the results attribute

Internal Structure of the customizeData Attribute

Table 6 Internal structure of the customizeData attribute

Example of the metadata attribute:

"metaData": {
  "parameters" : [{
    "name" : "a test for metadata parameter",
    "type" : "Float",
    // "$string:parameters_description" is a file resource index.
    "description" : "$string:parameters_description"
  }],
  "results" : [{
    "name" : "a test for metadata result",
    "type" : "Float",
    "description" : "$string:results_description"
  }],
  "customizeData" : [{
    "name" : "a customizeData",
    "value" : "string",
    "extra" : "$string:customizeData_description"
  }]
}

deviceType Attribute

Table 7 Values of the deviceType attribute

Internal Structure of the abilities Attribute

By default, application icons cannot be hidden from the home screen in OpenHarmony.

The OpenHarmony system imposes a strict rule on the presence of application icons. If no icon is configured in the HAP file of an application, the system creates a default icon for the application and displays it on the home screen.

Touching this icon will direct the user to the application details screen in Settings, as shown in Figure 1.

To hide an application icon from the home screen, you must configure the AllowAppDesktopIconHide privilege. For details, see Application Privilege Configuration Guide.

Objectives:

This requirement on application icons is intended to prevent malicious applications from deliberately configuring no icon to block uninstallation attempts.

Setting the application icon to be displayed on the home screen:

Set icon, label, and skills under abilities in the config.json file. In addition, make sure the skills configuration contains ohos.want.action.home and entity.system.home.

{
  "module":{

    ...

    "abilities": [{
      "icon": "$media:icon",
      "label": "Login",
      "skills": [{
        "actions": ["ohos.want.action.home"],
        "entities": ["entity.system.home"],
        "uris": []
      }]
    }],

    ...

  }
}

Display rules of application icons and labels on the home screen:

• The HAP file contains Page ability configuration.
  • The application icon on the home screen is set under abilities in the config.json file.
    • The application does not have the privilege to hide its icon from the home screen.
      • The application icon displayed on the home screen is the icon configured for the Page ability.
      • The application label displayed on the home screen is the label configured for the Page ability. If no label is configured, the bundle name is returned.
      • The name of the Page ability is displayed.
      • When the user touches the home screen icon, the home screen of the Page ability is displayed.
    • The application has the privilege to hide its icon from the home screen.
      • The information about the application is not returned during home screen information query, and the icon of the application is not displayed on the home screen.
  • The application icon on the home screen is not set under abilities in the config.json file.
    • The application does not have the privilege to hide its icon from the home screen.
      • The application icon displayed on the home screen is the default icon.
      • The application label displayed on the home screen is the bundle name of the application.
      • Touching the application icon on the home screen will direct the user to the application details screen shown in Figure 1.
    • The application has the privilege to hide its icon from the home screen.
      • The information about the application is not returned during home screen information query, and the icon of the application is not displayed on the home screen.
• The HAP file does not contain Page ability configuration.
  • The application does not have the privilege to hide its icon from the home screen.
    • The application icon displayed on the home screen is the default icon.
    • The application label displayed on the home screen is the bundle name of the application.
    • Touching the application icon on the home screen will direct the user to the application details screen shown in Figure 1.
  • The application has the privilege to hide its icon from the home screen.
    • The information about the application is not returned during home screen information query, and the icon of the application is not displayed on the home screen.

Note: The label displayed on the application details screen may be different from that displayed on the home screen. For non-Page abilities, it is the entry label set (if any).

Figure 1 Application details screen

Table 8 Internal structure of the abilities attribute

Internal Structure of the uriPermission Attribute

Table 9 Internal structure of the uriPermission attribute

Example of the abilities attribute structure:

"abilities": [
  {
    "name": ".EntryAbility",
    "description": "test main ability",
    // $media:ic_launcher is a media resource.
    "icon": "$media:ic_launcher",
    // $string:example is a string resource.
    "label": "$string:example",
    "launchType": "standard",
    "orientation": "unspecified",
    "permissions": [], 
    "visible": true,
    "skills": [
      {
        "actions": [
          "action.system.home"
        ],
        "entities": [
          "entity.system.home"
        ]
      }
    ],
    "configChanges": [
      "locale", 
      "layout", 
      "fontSize", 
      "orientation"
    ], 
    "type": "page",
    "startWindowIcon": "$media:icon",
    "startWindowBackground": "$color:red",
    "removeMissionAfterTerminate": true
  },
  {
    "name": ".PlayService",
    "description": "example play ability",
    "icon": "$media:ic_launcher",
    "label": "$string:example",
    "launchType": "standard",
    "orientation": "unspecified",
    "visible": false,
    "skills": [
      {
        "actions": [
          "action.play.music",
          "action.stop.music"
        ],
        "entities": [
          "entity.audio"
        ]
      }
    ],
    "type": "service",
    "backgroundModes": [
      "audioPlayback"
    ]
  },
  {
    "name": ".UserADataAbility",
    "type": "data",
    "uri": "dataability://com.example.world.test.UserADataAbility",
    "visible": true
  }
]

Internal Structure of the skills Attribute

Table 10 Internal structure of the skills attribute

Internal Structure of the uris Attribute

Table 11 Internal structure of the uris attribute

Example of the skills attribute structure:

"skills": [
  {
    "actions": [
      "action.system.home"
    ], 
    "entities": [
      "entity.system.home"
    ],
    "uris": [
      {
        "scheme": "http",
        "host": "www.example.com",
        "port": "8080",
        "path": "query/student/name",
        "type": "text/*"
      }
    ]
  }
]

Internal Structure of the reqPermissions Attribute

Table 12 Internal structure of the reqPermissions attribute

Internal Structure of the usedScene Attribute

Table 13 Internal structure of the usedScene attribute

Internal Structure of the js Attribute

Table 14 Internal structure of the js attribute

Internal Structure of the window Attribute

Table 15 Internal structure of the window attribute

Internal Structure of the mode Attribute

Table 16 Internal structure of the mode attribute

Example of the js attribute structure:

"js": [
  {
    "name": "default", 
    "pages": [      
      "pages/index/index",
      "pages/detail/detail"
    ],     
    "window": {
      "designWidth": 720,
      "autoDesignWidth": false
    },
    "type": "form"
  }
]

Internal Structure of the shortcuts Attribute

Table 17 Internal structure of the shortcuts attribute

Internal Structure of the intents Attribute

Table 18 Internal structure of the intents attribute

Example of the shortcuts attribute structure:

"shortcuts": [
  {
    "shortcutId": "id",
    // $string:shortcut is a string resource index.
    "label": "$string:shortcut",
    "intents": [
      {
        "targetBundle": "com.example.world.test",
        "targetClass": "com.example.world.test.entry.EntryAbility"
      }
    ]
  }
]

Internal Structure of the forms Attribute

Table 19 Internal structure of the forms attribute

Internal Structure of the customizeData Attribute

Table 20 Internal structure of the customizeData attribute

Example of the forms attribute structure:

"forms": [
  {
    "name": "Form_Js",
    "description": "It's Js Form",
    "type": "JS",
    "jsComponentName": "card",
    "colorMode": "auto",
    "isDefault": true,
    "updateEnabled": true,
    "scheduledUpdateTime": "11:00",
    "updateDuration": 1,
    "defaultDimension": "2*2",
    "supportDimensions": [
      "2*2",
      "2*4",
      "4*4"
    ]
  },
  {
    "name": "Form_Js",
    "description": "It's JS Form",
    "type": "Js",
    "colorMode": "auto",
    "isDefault": false,
    "updateEnabled": true,
    "scheduledUpdateTime": "21:05",
    "updateDuration": 1,
    "defaultDimension": "1*2",
    "supportDimensions": [
      "1*2"
    ],
    "landscapeLayouts": [
      "$layout:ability_form"
    ],
    "portraitLayouts": [
      "$layout:ability_form"
    ],
    "formConfigAbility": "ability://com.example.myapplication.fa/.EntryAbility",
    "metaData": {
      "customizeData": [
        {
          "name": "originWidgetName",
          "value": "com.example.weather.testWidget"
        }
      ]
    }
  }
]

Internal Structure of the distributionFilter Attribute

Table 21 Internal structure of the distributionFilter attribute

Internal Structure of the apiVersion Attribute

Table 22 Internal structure of the apiVersion attribute

Internal Structure of the screenShape Attribute

Table 23 Internal structure of the screenShape attribute

Internal Structure of the screenWindow Attribute

Table 24 Internal structure of the screenWindow attribute

Internal Structure of the screenDensity Attribute

Table 25 Internal structure of the screenDensity attribute

Internal Structure of the countryCode attribute

Table 26 Internal structure of the countryCode attribute

Example of the distributionFilter attribute structure:

"distributionFilter":  {
  "apiVersion": {
    "policy": "include",
    "value": [4,5]
  },
  "screenShape": {
    "policy": "include",
    "value": ["circle","rect"]
  },
  "screenWindow": {
    "policy": "include",
    "value": ["454*454","466*466"]
  },
  "screenDensity":{
    "policy": "exclude",
    "value": ["ldpi","xldpi"]
  },
  "countryCode": {
    "policy":"include",
    "value":["CN","HK"]
  }
}

Internal Structure of the commonEvents Attribute

Table 27 Internal structure of the commonEvents attribute

Example of the commonEvents attribute structure:

"commonEvents": [
  {
    "name": ".EntryAbility",
    "permission": "ohos.permission.GET_BUNDLE_INFO",
    "data": [
      "com.example.demo",
      "100"
    ],
    "events": [
      "install",
      "update"
    ]
  }
]

Internal Structure of the testRunner Attribute

Table 28 Internal structure of the testRunner attribute

"testRunner": {
  "name": "myTestRunnerName",
  "srcPath": "etc/test/TestRunner.ts"
}

definePermission applies only to system applications and does not take effect for third-party applications.

Internal Structure of the definePermissions Attribute

Table 29 Internal structure of the definePermissions attribute