@ohos.app.form.formInfo (formInfo)
The formInfo module provides types and enums related to the widget information and state.
NOTE
The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import { formInfo } from '@kit.FormKit';
formInfo.FormInfo
Defines the widget information.
System capability: SystemCapability.Ability.Form
| Name | Type | Readable | Writable | Description |
|---|---|---|---|---|
| bundleName | string | Yes | No | Name of the bundle to which the widget belongs. Atomic service API: This API can be used in atomic services since API version 11. |
| moduleName | string | Yes | No | Name of the module to which the widget belongs. Atomic service API: This API can be used in atomic services since API version 11. |
| abilityName | string | Yes | No | Name of the ability to which the widget belongs. Atomic service API: This API can be used in atomic services since API version 11. |
| name | string | Yes | No | Name of an application or atomic service. Atomic service API: This API can be used in atomic services since API version 11. |
| displayName11+ | string | Yes | No | Widget name. Atomic service API: This API can be used in atomic services since API version 11. |
| displayNameId11+ | number | Yes | No | ID of the widget name displayed during widget preview. Atomic service API: This API can be used in atomic services since API version 11. |
| description | string | Yes | No | Description of the widget. Atomic service API: This API can be used in atomic services since API version 11. |
| descriptionId10+ | number | Yes | No | ID of the widget description. Atomic service API: This API can be used in atomic services since API version 11. |
| type | FormType | Yes | No | Type of the widget. Currently, JS and ArkTS widgets are supported. Atomic service API: This API can be used in atomic services since API version 11. |
| jsComponentName | string | Yes | No | Name of the component used in the JS widget. Atomic service API: This API can be used in atomic services since API version 11. |
| colorMode | ColorMode | Yes | No | Color mode of the widget. Atomic service API: This API can be used in atomic services since API version 11. |
| isDefault | boolean | Yes | No | Whether the widget is the default one. Atomic service API: This API can be used in atomic services since API version 11. |
| updateEnabled | boolean | Yes | No | Whether the widget is updatable. Atomic service API: This API can be used in atomic services since API version 11. |
| formVisibleNotify | boolean | Yes | No | Whether to send a notification when the widget is visible. Atomic service API: This API can be used in atomic services since API version 11. |
| scheduledUpdateTime | string | Yes | No | Time when the widget was updated. Atomic service API: This API can be used in atomic services since API version 11. |
| formConfigAbility | string | Yes | No | Configuration ability of the widget, that is, the ability corresponding to the option in the selection box displayed when the widget is long pressed. Atomic service API: This API can be used in atomic services since API version 11. |
| updateDuration | number | Yes | No | Update period of the widget. Atomic service API: This API can be used in atomic services since API version 11. |
| defaultDimension | number | Yes | No | Widget specifications. Atomic service API: This API can be used in atomic services since API version 11. |
| supportDimensions | Array<number> | Yes | No | Dimensions supported by the widget. For details, see FormDimension. Atomic service API: This API can be used in atomic services since API version 11. |
| customizeData | Record<string, string> | Yes | No | Custom data of the widget. Atomic service API: This API can be used in atomic services since API version 11. |
| isDynamic10+ | boolean | Yes | No | Whether the widget is a dynamic widget. ArkTS widgets are classified into dynamic and static widgets. JS widgets are all dynamic widgets. Atomic service API: This API can be used in atomic services since API version 11. |
| transparencyEnabled11+ | boolean | Yes | No | Whether the widget supports the setting of the background transparency. For ArkTS widgets, the support for the background transparency setting depends on user configurations. For JS widgets, the background transparency setting is not supported. Atomic service API: This API can be used in atomic services since API version 11. |
| supportedShapes12+ | Array<number> | Yes | No | Shapes supported by the widget. For details about the available shapes, see FormShape12+. Atomic service API: This API can be used in atomic services since API version 12. |
| previewImages18+ | Array<number> | Yes | No | Resource IDs of the preview images of the widget. Atomic service API: This API can be used in atomic services since API version 18. |
| enableBlurBackground18+ | boolean | Yes | No | Whether the widget uses a blur background. Atomic service API: This API can be used in atomic services since API version 18. |
| renderingMode18+ | RenderingMode | Yes | No | Widget rendering mode. Atomic service API: This API can be used in atomic services since API version 18. |
formInfo.FormType
Enumerates the widget types.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| JS | 1 | JS widget. |
| eTS | 2 | ArkTS widget. |
formInfo.ColorMode
Enumerates the color modes supported by the widget.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| MODE_AUTO | -1 | Auto mode. |
| MODE_DARK | 0 | Dark mode. |
| MODE_LIGHT | 1 | Light mode. |
formInfo.FormStateInfo
Describes the widget state information.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Type | Readable | Writable | Description |
|---|---|---|---|---|
| formState | FormState | Yes | No | Widget state. |
| want | Want | Yes | No | Want text. |
formInfo.FormState
Enumerates the widget states.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| UNKNOWN | -1 | Unknown state. |
| DEFAULT | 0 | Default state. |
| READY | 1 | Ready state. |
formInfo.FormParam
Enumerates the widget parameters.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| IDENTITY_KEY | 'ohos.extra.param.key.form_identity' | Widget ID. Atomic service API: This API can be used in atomic services since API version 11. |
| DIMENSION_KEY | 'ohos.extra.param.key.form_dimension' | Widget dimension. Atomic service API: This API can be used in atomic services since API version 11. |
| NAME_KEY | 'ohos.extra.param.key.form_name' | Widget name. Atomic service API: This API can be used in atomic services since API version 11. |
| MODULE_NAME_KEY | 'ohos.extra.param.key.module_name' | Name of the module to which the widget belongs. Atomic service API: This API can be used in atomic services since API version 11. |
| WIDTH_KEY | 'ohos.extra.param.key.form_width' | Widget width. Atomic service API: This API can be used in atomic services since API version 11. |
| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | Widget height. Atomic service API: This API can be used in atomic services since API version 11. |
| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | Temporary widget. Atomic service API: This API can be used in atomic services since API version 11. |
| ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | Ability name. Atomic service API: This API can be used in atomic services since API version 11. |
| BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | Bundle name. Atomic service API: This API can be used in atomic services since API version 11. |
| LAUNCH_REASON_KEY10+ | 'ohos.extra.param.key.form_launch_reason' | Reason for creating the widget. Atomic service API: This API can be used in atomic services since API version 11. |
| PARAM_FORM_CUSTOMIZE_KEY10+ | 'ohos.extra.param.key.form_customize' | Custom data. Atomic service API: This API can be used in atomic services since API version 11. |
| FORM_RENDERING_MODE_KEY11+ | 'ohos.extra.param.key.form_rendering_mode' | Widget rendering mode. Atomic service API: This API can be used in atomic services since API version 12. |
| HOST_BG_INVERSE_COLOR_KEY12+ | 'ohos.extra.param.key.host_bg_inverse_color' | Inverse background color of the widget client. Atomic service API: This API can be used in atomic services since API version 12. |
| FORM_LOCATION_KEY12+ | 'ohos.extra.param.key.form_location' | Widget location. OTHER -1 (other locations) DESKTOP 0 (desktop) FORM_CENTER 1 (widget center of the desktop) FORM_MANAGER 2 (widget manager of the desktop) NEGATIVE_SCREEN 3 (minus-one screen) FORM_CENTER_NEGATIVE_SCREEN 4 (widget center of the minus-one screen) FORM_MANAGER_NEGATIVE_SCREEN 5 (widget manager of the minus-one screen) SCREEN_LOCK 6 (lock screen) AI_SUGGESTION 7 (Celia suggestions area) |
| FORM_PERMISSION_NAME_KEY12+ | 'ohos.extra.param.key.permission_name' | Name of the permission. Atomic service API: This API can be used in atomic services since API version 12. |
| FORM_PERMISSION_GRANTED_KEY12+ | 'ohos.extra.param.key.permission_granted' | Whether the permission is granted. Atomic service API: This API can be used in atomic services since API version 12. |
formInfo.FormDimension
Enumerates the widget dimensions.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| Dimension_1_2 | 1 | 1 x 2. Atomic service API: This API can be used in atomic services since API version 11. |
| Dimension_2_2 | 2 | 2 x 2. Atomic service API: This API can be used in atomic services since API version 11. |
| Dimension_2_4 | 3 | 2 x 4. Atomic service API: This API can be used in atomic services since API version 11. |
| Dimension_4_4 | 4 | 4 x 4. Atomic service API: This API can be used in atomic services since API version 11. |
| Dimension_2_1 | 5 | 2 x 1. Atomic service API: This API can be used in atomic services since API version 11. |
| DIMENSION_1_111+ | 6 | 1 x 1. Atomic service API: This API can be used in atomic services since API version 11. |
| DIMENSION_6_412+ | 7 | 6 x 4. Atomic service API: This API can be used in atomic services since API version 12. |
| DIMENSION_2_318+ | 8 | 2 x 3. Atomic service API: This API can be used for wearable devices in atomic services since API version 18. |
| DIMENSION_3_318+ | 9 | 3 x 3. Atomic service API: This API can be used for wearable devices in atomic services since API version 18. |
formInfo.FormShape12+
Enumerates the widget shapes.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| RECT | 1 | Rectangle. Atomic service API: This API can be used in atomic services since API version 12. |
| CIRCLE | 2 | Circle. Atomic service API: This API can be used in atomic services since API version 12. |
formInfo.FormInfoFilter
Defines the widget information filter. Only the widget information that meets the filter is returned.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Type | Mandatory | Description |
|---|---|---|---|
| moduleName | string | No | Only the information about the widget whose moduleName is the same as the provided value is returned. If this parameter is not set, moduleName is not used for filtering. |
formInfo.VisibilityType
Enumerates the visibility types of the widget.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| UNKNOWN10+ | 0 | The visibility type of the widget is unknown. |
| FORM_VISIBLE | 1 | The widget is visible. |
| FORM_INVISIBLE | 2 | The widget is invisible. |
formInfo.LaunchReason10+
Enumerates the reasons for creating a widget.
Atomic service API: This API can be used in atomic services since API version 11.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| FORM_DEFAULT | 1 | The widget is created by default. |
| FORM_SHARE | 2 | The widget is created for sharing. |
formInfo.RenderingMode18+
Enumerates the rendering modes supported by the widget.
Atomic service API: This API can be used in atomic services since API version 18.
System capability: SystemCapability.Ability.Form
| Name | Value | Description |
|---|---|---|
| AUTO_COLOR | 0 | Auto mode. |
| FULL_COLOR | 1 | Full-color mode. |
| SINGLE_COLOR | 2 | Single-color mode. |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙@ohos.app.form.formAgent (FormAgent) (System API)
harmony 鸿蒙@ohos.app.form.formBindingData (formBindingData)
harmony 鸿蒙@ohos.app.form.FormEditExtensionAbility (FormEditExtensionAbility)
harmony 鸿蒙@ohos.app.form.FormExtensionAbility (FormExtensionAbility) (System API)
harmony 鸿蒙@ohos.app.form.FormExtensionAbility (FormExtensionAbility)
harmony 鸿蒙@ohos.app.form.formHost (formHost) (System API)
harmony 鸿蒙@ohos.app.form.formInfo (formInfo) (System API)
harmony 鸿蒙@ohos.app.form.formObserver (formObserver) (System API)