Lines Matching refs:of

1 # Structure of the module Tag
6 **Table 1** Internal structure of the module tag
11of the HAP file, which must be unique in the application. The value is a string with a maximum of
12 | name | Class name of the HAP file. The value is a string with a maximum of 255 bytes, in the reve…
13 | description | Description of the HAP file. The value is a string with a maximum of 255 bytes. If …
15 |deviceType | <!--RP1-->Type of device on which the ability can run. The device types predefined in…
16 |distro | Distribution description of the HAP file.| Object| No|
17 |metaData | Metadata of the HAP file.| Object| Yes (initial value: left empty)|
18 | abilities | All abilities in the current module. The value is an array of objects, each of which …
19 | js | A set of JS modules developed using ArkUI. The value is an array of objects, each of which r…
20 | shortcuts | Shortcuts of the application. The value is an array of objects, each of which represe…
22of the application. The options are as follows:<br>- **dark**: Resources applicable for the dark m…
24 …er, which must contain the subscriber name, required permissions, and list of the common events su…
25 | entryTheme | Keyword of an internal theme. Set it to the resource index of the name.| String| Yes…
27of the HAP or HSP file is generated by the packaging tool. The hash value (if any) is used to dete…
28of the current HAP to a separate folder (named after the module) in the **libs** directory. This i…
30 Example of the **module** tag structure:
94 ## Internal Structure of the distro Attribute
96 **Table 2** Internal structure of the distro attribute
100of the HAP file. The maximum length is 31 bytes. This name can be changed during application updat…
101 | moduleType | Type of the HAP file, which can **entry**, **feature**, or **har**.| String| No|
102of the same application. If this tag is set to **false** for an entry-type HAP file, it can be se…
106 Example of the **distro** attribute structure:
117 ## Internal Structure of the metadata Attribute
119 **Table 3** Internal structure of the metadata attribute
123 | parameters | Metadata of the parameters to be passed for calling the ability. The metadata of eac…
124 | results | Metadata of the ability return value. The metadata of each return value consists of the…
125 | customizeData | Custom metadata of the parent component. **parameters** and **results** cannot be…
127 ## Internal Structure of the parameters Attribute
129 **Table 4** Internal structure of the parameters attribute
133 …ription of the parameter. The value can be a string or a resource index to descriptions in multipl…
134 | name | Name of the parameter passed for calling the ability. The value can contain a maximum of 2…
135 | type | Type of the parameter passed for calling the ability, for example, **Integer**.| String| N…
137 ## Internal Structure of the results Attribute
139 **Table 5** Internal structure of the results attribute
143 …ption of the return value. The value can be a string or a resource index to descriptions in multip…
144 | name | Name of the return value. The value can contain a maximum of 255 bytes.| String| Yes (init…
145 | type | Type of the return value, for example, **Integer**.| String| No|
147 ## Internal Structure of the customizeData Attribute
149 **Table 6** Internal structure of the customizeData attribute
153 | name | Key of the data element. The value is a string with a maximum of 255 bytes.| String| Yes (…
154 | value | Value of the data element. The value is a string with a maximum of 255 bytes.| String| Ye…
155 | extra | Custom format of the data element. The value is a resource index that identifies the data…
158 Example of the metadata attribute:
183 **Table 7** Values of the deviceType attribute
196 ## Internal Structure of the abilities Attribute
198 **Table 8** Internal structure of the abilities attribute
202of the process running the application or ability. If the **process** attribute is configured in t…
203of "*bundleName*.*className*", for example, **"com.example.myapplication.EntryAbility"**. Alternat…
204 …cription of the ability. The value can be a string or a resource index to descriptions in multiple…
205of the ability, if the **actions** value contains **action.system.home** and the **entities** valu…
206of the ability, if the **actions** value contains **action.system.home** and the **entities** valu…
207 | uri | Uniform Resource Identifier (URI) of the ability. The value can contain a maximum of 255 by…
208 | launchType | Launch type of the ability. The value can be **multiton** or **singleton**.<br>**sta…
210of another application to call the current ability. The value is an array of permission names pred…
211 |skills | Types of the **want** that can be accepted by the ability.| Object array| Yes (initial va…
212 …ired to run the ability. The value is an array of up to 512 elements, each of which contains a max…
214 …ovide the capability of interacting with users.<br>**service**: PA developed using the Service tem…
215of the ability. This attribute applies only to the ability using the Page template. The options ar…
216 | backgroundModes | Background service type of the ability. You can assign multiple background serv…
218 … the ability using the Data template. The value is a string with a maximum of 255 bytes. This attr…
219 … the ability using the Data template. The value is a string with a maximum of 255 bytes.| String| …
220of the IMSI is changed. Typical scenario: A SIM card is detected, and the MCC is updated.<br>**mnc…
221of the ability. This attribute applies only to the ability using the Page template. By default, al…
222of the **targetAbility** attribute. The target ability must belong to the same application as the …
225 | srcLanguage | Programming language of the ability, which you can specify when creating the projec…
226 | srcPath | JS code path corresponding to the ability. The value can contain a maximum of 127 bytes…
227 …ess. This attribute consists of the **mode** and **path** sub-attributes. This attribute is valid …
228 | startWindowIcon | Index to the icon file of the ability startup page. This attribute applies only…
229 | startWindowBackground | Index to the background color resource file of the ability startup page. …
264 …t on the home screen. Touching this icon will direct the user to the home page of the Page ability.
267 …when the home screen queries the information, and the entry icon and label of the application are …
271 …* The system uses the bundle name of the application as the entry label and displays it on the hom…
273 …when the home screen queries the information, and the entry icon and label of the application are …
277 …* The system uses the bundle name of the application as the entry label and displays it on the hom…
279 …when the home screen queries the information, and the entry icon and label of the application are …
286 ## Internal Structure of the uriPermission Attribute
288 **Table 9** Internal structure of the uriPermission attribute
292 | path | Path. The value can contain maximum of 255 bytes.| String| No|
296 Example of the **abilities** attribute structure:
364 ## Internal Structure of the skills Attribute
366 **Table 10** Internal structure of the skills attribute
370 | actions | Actions of the **want** that can be accepted by the ability. Generally, the value is an…
371 | entities | Entities of the **want** that can be accepted by the ability, such as video and home a…
372of each part: &lt;scheme&gt;://&lt;host&gt;:&lt;port&gt;[&lt;path&gt;\|&lt;pathStartWith&gt;\|&lt;…
374 ## Internal Structure of the uris Attribute
376 **Table 11** Internal structure of the uris attribute
380 | scheme | Scheme of the URI.| String| No|
381 | host | Host value of the URI.| String| Yes (initial value: left empty)|
382 | port | Port number of the URI.| String| Yes (initial value: left empty)|
383 | pathStartWith | **pathStartWith** value of the URI.| String| Yes (initial value: left empty)|
384 | path | **path** value of the URI.| String| Yes (initial value: left empty)|
385 | pathRegx | **pathRegx** value of the URI.| String| Yes (initial value: left empty)|
386 …**type** value of the URI. The value is a MIME type. Typical values include **"audio/aac"** and **…
389 Example of the **skills** attribute structure:
413 ## Internal Structure of the reqPermissions Attribute
415 **Table 12** Internal structure of the reqPermissions attribute
419 | name | Name of the permission to request.| String| No|
421 | usedScene | Scene under which the permission is used. It consists of the **abilities** and **when…
423 ## Internal Structure of the usedScene Attribute
425 **Table 13** Internal structure of the usedScene attribute
429 | ability | Names of abilities that require the permission.| String array| Yes (initial value: all …
432 ## Internal Structure of the js Attribute
434 **Table 14** Internal structure of the js attribute
438 | name | Name of the JavaScript component.| String| No|
439of pages in the JavaScript component, in the format of "Page path + Page name". The page path is b…
441 | type | Type of the JS component. The options are as follows:<br>**normal**: indicates an applicat…
442 |mode | Development mode of the JS component.| Object| Yes (initial value: left empty)|
444 ## Internal Structure of the window Attribute
446 **Table 15** Internal structure of the window attribute
450 | designWidth | Baseline width for page design. The size of an element is scaled by the actual devi…
453 ## Internal Structure of the mode Attribute
455 **Table 16** Internal structure of the mode attribute
459 | type | Type of the JS component. The value can be **pageAbility** or **form**.| String| Yes (init…
460 | syntax | Syntax type of the JS component. The value can be **"hml"** or **"ets"**.| String| Yes (…
463 Example of the **js** attribute structure:
486 ## Internal Structure of the shortcuts Attribute
488 **Table 17** Internal structure of the shortcuts attribute
492 | shortcutId | ID of the shortcut. The value is a string with a maximum of 63 bytes.| String| No|
493of the shortcut, that is, the text description displayed for the shortcut. The value can be a stri…
494 | icon | Icon of the shortcut. The value is a resource index to the description.| String| Yes (init…
495 | intents | Wants to which the shortcut points. The attribute consists of the **targetClass** and *…
497 ## Internal Structure of the intents Attribute
499 **Table 18** Internal structure of the intents attribute
503 | targetClass | Target class of the shortcut.| String| Yes (initial value: left empty)|
504 | targetBundle | Application bundle name for the target ability of the shortcut.| String| Yes (init…
507 Example of the **shortcuts** attribute structure:
525 ## Internal Structure of the forms Attribute
527 **Table 19** Internal structure of the forms attribute
531 | name | Class name of the widget. The value is a string with a maximum of 127 bytes.| String| No|
532 …iption of the widget. The value can be a string or a resource index to descriptions in multiple la…
534 | type | Type of the widget. The options are as follows:<br>**JS**: JavaScript widget.<br>**Java**:…
535 | colorMode | Color mode of the widget. The options are as follows:<br>**auto**: The widget adopts …
537 | defaultDimension | Default grid style of the widget. The value must be from the **supportDimensio…
540 | updateDuration | Interval to update the widget. The value is a natural number, in the unit of 30 …
541 | formConfigAbility | Name of the ability used to adjust the widget.| String| Yes (initial value: l…
542 | jsComponentName | Component name of the widget. The value is a string with a maximum of 127 bytes…
543 | metaData | Metadata of the widget. This attribute contains the array of the **customizeData** att…
546 ## Internal Structure of the customizeData Attribute
548 **Table 20** Internal structure of the customizeData attribute
552 | name | Key name that identifies a data item. The value is a string with a maximum of 255 bytes.| …
553 | value | Value of the data item. The value is a string with a maximum of 255 bytes.| String| Yes (…
554 | extra | Format of the current custom data. The value is the resource value of **extra**.| String|…
557 Example of the **forms** attribute structure:
610 ## Internal Structure of the distroFilter Attribute
612 **Table 21** Internal structure of the distroFilter attribute
619 |screenDensity | Pixel density of the screen, in dots per inch (DPI).| Object array| Yes (initial v…
620 …tion. For details, see the ISO-3166-1 standard. Multiple enumerated values of countries and region…
622 ## Internal Structure of the apiVersion Attribute
624 **Table 22** Internal structure of the apiVersion attribute
628 …**.<br>- **exclude**: Exclude the matches of the sub-attribute value.<br>- **include**: Include th…
629 …n 5 and API version 6 for the same device model, two installation packages of the entry type can b…
631 ## Internal Structure of the screenShape Attribute
633 **Table 23** Internal structure of the screenShape attribute
637 …**.<br>- **exclude**: Exclude the matches of the sub-attribute value.<br>- **include**: Include th…
638 …n 5 and API version 6 for the same device model, two installation packages of the entry type can b…
640 ## Internal Structure of the screenWindow Attribute
642 **Table 24** Internal structure of the screenWindow attribute
646 …**.<br>- **exclude**: Exclude the matches of the sub-attribute value.<br>- **include**: Include th…
647 …n 5 and API version 6 for the same device model, two installation packages of the entry type can b…
649 ## Internal Structure of the screenDensity Attribute
651 **Table 25** Internal structure of the screenDensity attribute
655 …**.<br>- **exclude**: Exclude the matches of the sub-attribute value.<br>- **include**: Include th…
656of (0, 120].<br>**mdpi**: medium-scale DPI. This value is applicable to devices with a DPI range o…
658 ## Internal Structure of the countryCode attribute
660 **Table 26** Internal structure of the countryCode attribute
664 …**.<br>- **exclude**: Exclude the matches of the sub-attribute value.<br>- **include**: Include th…
665of the area to which the application is to be distributed. The value is a string array, of which e…
668 Example of the **distroFilter** attribute structure:
695 ## Internal Structure of the commonEvents Attribute
697 **Table 27** Internal structure of the commonEvents attribute
701 | name | Name of the static common event. The value can contain a maximum of 127 bytes.| String| No|
702 …equired to implement static common events. The value can contain a maximum of 255 bytes.| String| …
704 | type | Type array of the current static common event.| String array| Yes (initial value: left emp…
705 | events | A set of events for the wants that can be received. The value can be system predefined o…
708 Example of the **commonEvents** attribute structure:
727 ## Internal Structure of the testRunner Attribute
729 **Table 28** Internal structure of the testRunner attribute
733 | name | Name of the test runner object. The value can contain a maximum of 255 bytes.| String| No|
734 | srcPath | Code path of the test runner. The maximum length of this tag is 255 bytes.| String| No|
746 ## Internal Structure of the definePermissions Attribute
747 **Table 29** Internal structure of the definePermissions attribute
751 | name | Name of a permission. The value can contain a maximum of 255 bytes.| String| No|
756 | label | Brief description of the permission. The value is a resource index to the description.| S…
757 | description | Detailed description of the permission. The value is a string with a maximum of 255…