“76360c5342f99be792165d2d5d0c988e4504c99e”上不存在“tests/examples/git@gitcode.net:qq_37101384/tdengine.git”
提交 0d1e9382 编写于 作者: H HelloCrease

update docs

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 2e098766
...@@ -54,8 +54,10 @@ To make you better understand how functions work together and jumpstart your app ...@@ -54,8 +54,10 @@ To make you better understand how functions work together and jumpstart your app
API references encompass all components and APIs available in OpenHarmony, helping you use and integrate APIs more effectively. API references encompass all components and APIs available in OpenHarmony, helping you use and integrate APIs more effectively.
They are organized as follows: They are organized as follows:
- [Component Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md)
- [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md) - [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md)
- [Component Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md)
- APIs - APIs
- [JS and TS APIs](reference/apis/Readme-EN.md) - [JS and TS APIs](reference/apis/Readme-EN.md)
- Native APIs - Native APIs
......
...@@ -54,6 +54,10 @@ To make you better understand how functions work together and jumpstart your app ...@@ -54,6 +54,10 @@ To make you better understand how functions work together and jumpstart your app
API references encompass all components and APIs available in OpenHarmony, helping you use and integrate APIs more effectively. API references encompass all components and APIs available in OpenHarmony, helping you use and integrate APIs more effectively.
They are organized as follows: They are organized as follows:
- [Component Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md)
- [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md)
- [JS and TS APIs](reference/apis/js-apis-DataUriUtils.md) - [JS and TS APIs](reference/apis/js-apis-DataUriUtils.md)
- Native APIs - Native APIs
- [Standard Library](reference/native-lib/third_party_libc/musl.md) - [Standard Library](reference/native-lib/third_party_libc/musl.md)
......
# Development References # Development References
- [JavaScript-based Web-like Development Paradigm](arkui-js/Readme-EN.md) - [Component Reference(TypeScript-based Declarative Development Paradigm)](arkui-ts/Readme-EN.md)
- [TypeScript-based Declarative Development Paradigm](arkui-ts/Readme-EN.md) - [Component Reference(JavaScript-based Web-like Development Paradigm)](arkui-js/Readme-EN.md)
- [APIs](apis/Readme-EN.md) - [APIs](apis/Readme-EN.md)
- [JS (eTS Included) APIs](apis/Readme-EN.md) - [JS (eTS Included) APIs](apis/Readme-EN.md)
- Native APIs - Native APIs
- [Standard Library](native-lib/third_party_libc/musl.md) - [Standard Library](native-lib/third_party_libc/musl.md)
......
# UI Development # UI Development
- [ArkUI Overview](arkui-overview.md) - [ArkUI Overview](arkui-overview.md)
- TypeScript-based Declarative Development Paradigm
- [Overview](ui-ts-overview.md)
- Framework Overview
- File Organization
- [Directory Structure](ts-framework-directory.md)
- [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md)
- ["js" Tag](ts-framework-js-tag.md)
- Resource Access
- [Accessing Application Resources](ts-application-resource-access.md)
- [Accessing System Resources](ts-system-resource-access.md)
- [Media Resource Types](ts-media-resource-type.md)
- [Pixel Units](ts-pixel-units.md)
- [Types](ts-types.md)
- Declarative Syntax
- [Overview](ts-syntax-intro.md)
- General UI Description Specifications
- [Basic Concepts](ts-general-ui-concepts.md)
- Declarative UI Description Specifications
- [Configuration Without Parameters](ts-parameterless-configuration.md)
- [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md)
- [Attribute Configuration](ts-attribution-configuration.md)
- [Event Configuration](ts-event-configuration.md)
- [Child Component Configuration](ts-child-component-configuration.md)
- Componentization
- [@Component](ts-component-based-component.md)
- [@Entry](ts-component-based-entry.md)
- [@Preview](ts-component-based-preview.md)
- [@Builder](ts-component-based-builder.md)
- [@Extend](ts-component-based-extend.md)
- [@CustomDialog](ts-component-based-customdialog.md)
- [@Styles](ts-component-based-styles.md)
- About UI State Management
- [Basic Concepts](ts-ui-state-mgmt-concepts.md)
- Managing Component States
- [@State](ts-component-states-state.md)
- [@Prop](ts-component-states-prop.md)
- [@Link](ts-component-states-link.md)
- Managing Application States
- [AppStorage](ts-application-states-appstorage.md)
- [PersistentStorage](ts-application-states-apis-persistentstorage.md)
- [Environment](ts-application-states-apis-environment.md)
- Managing Other States
- [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md)
- [@Consume and @Provide](ts-other-states-consume-provide.md)
- [@Watch](ts-other-states-watch.md)
- About Rendering Control Syntax
- [if/else](ts-rending-control-syntax-if-else.md)
- [ForEach](ts-rending-control-syntax-foreach.md)
- [LazyForEach](ts-rending-control-syntax-lazyforeach.md)
- About @Component
- [build Function](ts-function-build.md)
- [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md)
- [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md)
- [Component Creation and Re-initialization](ts-component-creation-re-initialization.md)
- [About Syntactic Sugar](ts-syntactic-sugar.md)
- Common Component Development Guidelines
- [Button](ui-ts-basic-components-button.md)
- [Web](ui-ts-components-web.md)
- Common Layout Development Guidelines
- [Flex Layout](ui-ts-layout-flex.md)
- [Grid Layout](ui-ts-layout-grid-container.md)
- [Media Query](ui-ts-layout-mediaquery.md)
- Experiencing the Declarative UI
- [Creating a Declarative UI Project](ui-ts-creating-project.md)
- [Getting to Know Components](ui-ts-components.md)
- [Creating a Simple Page](ui-ts-creating-simple-page.md)
- Defining Page Layout and Connection
- [Building a Food Data Model](ui-ts-building-data-model.md)
- [Building a Food Category List Layout](ui-ts-building-category-list-layout.md)
- [Building a Food Category Grid Layout](ui-ts-building-category-grid-layout.md)
- [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md)
- JavaScript-based Web-like Development Paradigm - JavaScript-based Web-like Development Paradigm
- [Overview](ui-js-overview.md) - [Overview](ui-js-overview.md)
- Framework - Framework
...@@ -73,74 +144,4 @@ ...@@ -73,74 +144,4 @@
- [Animation Effect](ui-js-animate-dynamic-effects.md) - [Animation Effect](ui-js-animate-dynamic-effects.md)
- [Animation Frame](ui-js-animate-frame.md) - [Animation Frame](ui-js-animate-frame.md)
- [Custom Components](ui-js-custom-components.md) - [Custom Components](ui-js-custom-components.md)
- TypeScript-based Declarative Development Paradigm
- [Overview](ui-ts-overview.md)
- Framework Overview
- File Organization
- [Directory Structure](ts-framework-directory.md)
- [Rules for Accessing Application Code Files](ts-framework-file-access-rules.md)
- ["js" Tag](ts-framework-js-tag.md)
- Resource Access
- [Accessing Application Resources](ts-application-resource-access.md)
- [Accessing System Resources](ts-system-resource-access.md)
- [Media Resource Types](ts-media-resource-type.md)
- [Pixel Units](ts-pixel-units.md)
- [Types](ts-types.md)
- Declarative Syntax
- [Overview](ts-syntax-intro.md)
- General UI Description Specifications
- [Basic Concepts](ts-general-ui-concepts.md)
- Declarative UI Description Specifications
- [Configuration Without Parameters](ts-parameterless-configuration.md)
- [Configuration with Mandatory Parameters](ts-configuration-with-mandatory-parameters.md)
- [Attribute Configuration](ts-attribution-configuration.md)
- [Event Configuration](ts-event-configuration.md)
- [Child Component Configuration](ts-child-component-configuration.md)
- Componentization
- [@Component](ts-component-based-component.md)
- [@Entry](ts-component-based-entry.md)
- [@Preview](ts-component-based-preview.md)
- [@Builder](ts-component-based-builder.md)
- [@Extend](ts-component-based-extend.md)
- [@CustomDialog](ts-component-based-customdialog.md)
- [@Styles](ts-component-based-styles.md)
- About UI State Management
- [Basic Concepts](ts-ui-state-mgmt-concepts.md)
- Managing Component States
- [@State](ts-component-states-state.md)
- [@Prop](ts-component-states-prop.md)
- [@Link](ts-component-states-link.md)
- Managing Application States
- [AppStorage](ts-application-states-appstorage.md)
- [PersistentStorage](ts-application-states-apis-persistentstorage.md)
- [Environment](ts-application-states-apis-environment.md)
- Managing Other States
- [@Observed and @ObjectLink](ts-other-states-observed-objectlink.md)
- [@Consume and @Provide](ts-other-states-consume-provide.md)
- [@Watch](ts-other-states-watch.md)
- About Rendering Control Syntax
- [if/else](ts-rending-control-syntax-if-else.md)
- [ForEach](ts-rending-control-syntax-foreach.md)
- [LazyForEach](ts-rending-control-syntax-lazyforeach.md)
- About @Component
- [build Function](ts-function-build.md)
- [Initialization of Custom Components' Member Variables](ts-custom-component-initialization.md)
- [Custom Component Lifecycle Callbacks](ts-custom-component-lifecycle-callbacks.md)
- [Component Creation and Re-initialization](ts-component-creation-re-initialization.md)
- [About Syntactic Sugar](ts-syntactic-sugar.md)
- Common Component Development Guidelines
- [Button](ui-ts-basic-components-button.md)
- [Web](ui-ts-components-web.md)
- Common Layout Development Guidelines
- [Flex Layout](ui-ts-layout-flex.md)
- [Grid Layout](ui-ts-layout-grid-container.md)
- [Media Query](ui-ts-layout-mediaquery.md)
- Experiencing the Declarative UI
- [Creating a Declarative UI Project](ui-ts-creating-project.md)
- [Getting to Know Components](ui-ts-components.md)
- [Creating a Simple Page](ui-ts-creating-simple-page.md)
- Defining Page Layout and Connection
- [Building a Food Data Model](ui-ts-building-data-model.md)
- [Building a Food Category List Layout](ui-ts-building-category-list-layout.md)
- [Building a Food Category Grid Layout](ui-ts-building-category-grid-layout.md)
- [Implementing Page Redirection and Data Transmission](ui-ts-page-redirection-data-transmission.md)
...@@ -36,6 +36,77 @@ ...@@ -36,6 +36,77 @@
- [Test Framework Usage](ability/ability-delegator.md) - [Test Framework Usage](ability/ability-delegator.md)
- UI Development - UI Development
- [ArkUI Overview](ui/arkui-overview.md) - [ArkUI Overview](ui/arkui-overview.md)
- TypeScript-based Declarative Development Paradigm
- [Overview](ui/ui-ts-overview.md)
- Framework Overview
- File Organization
- [Directory Structure](ui/ts-framework-directory.md)
- [Rules for Accessing Application Code Files](ui/ts-framework-file-access-rules.md)
- ["js" Tag](ui/ts-framework-js-tag.md)
- Resource Management
- [Resource File Categories](ui/ui-ts-basic-resource-file-categories.md)
- [Accessing Resources](ui/ts-resource-access.md)
- [Pixel Units](ui/ts-pixel-units.md)
- [Types](ui/ts-types.md)
- Declarative Syntax
- [Overview](ui/ts-syntax-intro.md)
- General UI Description Specifications
- [Basic Concepts](ui/ts-general-ui-concepts.md)
- Declarative UI Description Specifications
- [Configuration Without Parameters](ui/ts-parameterless-configuration.md)
- [Configuration with Mandatory Parameters](ui/ts-configuration-with-mandatory-parameters.md)
- [Attribute Configuration](ui/ts-attribution-configuration.md)
- [Event Configuration](ui/ts-event-configuration.md)
- [Child Component Configuration](ui/ts-child-component-configuration.md)
- Componentization
- [@Component](ui/ts-component-based-component.md)
- [@Entry](ui/ts-component-based-entry.md)
- [@Preview](ui/ts-component-based-preview.md)
- [@Builder](ui/ts-component-based-builder.md)
- [@Extend](ui/ts-component-based-extend.md)
- [@CustomDialog](ui/ts-component-based-customdialog.md)
- [@Styles](ui/ts-component-based-styles.md)
- About UI State Management
- [Basic Concepts](ui/ts-ui-state-mgmt-concepts.md)
- Managing Component States
- [@State](ui/ts-component-states-state.md)
- [@Prop](ui/ts-component-states-prop.md)
- [@Link](ui/ts-component-states-link.md)
- Managing Application States
- [AppStorage](ui/ts-application-states-appstorage.md)
- [LocalStorage](ui/ui-ts-local-storage.md)
- [PersistentStorage](ui/ts-application-states-apis-persistentstorage.md)
- [Environment](ui/ts-application-states-apis-environment.md)
- Managing Other States
- [@Observed and @ObjectLink](ui/ts-other-states-observed-objectlink.md)
- [@Consume and @Provide](ui/ts-other-states-consume-provide.md)
- [@Watch](ui/ts-other-states-watch.md)
- About Rendering Control Syntax
- [if/else](ui/ts-rending-control-syntax-if-else.md)
- [ForEach](ui/ts-rending-control-syntax-foreach.md)
- [LazyForEach](ui/ts-rending-control-syntax-lazyforeach.md)
- About @Component
- [build Function](ui/ts-function-build.md)
- [Initialization of Custom Components' Member Variables](ui/ts-custom-component-initialization.md)
- [Custom Component Lifecycle Callbacks](ui/ts-custom-component-lifecycle-callbacks.md)
- [Component Creation and Re-initialization](ui/ts-component-creation-re-initialization.md)
- [About Syntactic Sugar](ui/ts-syntactic-sugar.md)
- Common Component Development Guidelines
- [Button](ui/ui-ts-basic-components-button.md)
- [Web](ui/ui-ts-components-web.md)
- Common Layout Development Guidelines
- [Flex Layout](ui/ui-ts-layout-flex.md)
- [Grid Layout](ui/ui-ts-layout-grid-container.md)
- [Media Query](ui/ui-ts-layout-mediaquery.md)
- Experiencing the Declarative UI
- [Creating a Declarative UI Project](ui/ui-ts-creating-project.md)
- [Getting to Know Components](ui/ui-ts-components.md)
- [Creating a Simple Page](ui/ui-ts-creating-simple-page.md)
- Defining Page Layout and Connection
- [Building a Food Data Model](ui/ui-ts-building-data-model.md)
- [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md)
- [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md)
- [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md)
- JavaScript-based Web-like Development Paradigm - JavaScript-based Web-like Development Paradigm
- [Overview](ui/ui-js-overview.md) - [Overview](ui/ui-js-overview.md)
- Framework - Framework
...@@ -108,79 +179,8 @@ ...@@ -108,79 +179,8 @@
- [Animation Effect](ui/ui-js-animate-dynamic-effects.md) - [Animation Effect](ui/ui-js-animate-dynamic-effects.md)
- [Animation Frame](ui/ui-js-animate-frame.md) - [Animation Frame](ui/ui-js-animate-frame.md)
- [Custom Components](ui/ui-js-custom-components.md) - [Custom Components](ui/ui-js-custom-components.md)
- TypeScript-based Declarative Development Paradigm
- [Overview](ui/ui-ts-overview.md)
- Framework Overview
- File Organization
- [Directory Structure](ui/ts-framework-directory.md)
- [Rules for Accessing Application Code Files](ui/ts-framework-file-access-rules.md)
- ["js" Tag](ui/ts-framework-js-tag.md)
- Resource Management
- [Resource File Categories](ui/ui-ts-basic-resource-file-categories.md)
- [Accessing Resources](ui/ts-resource-access.md)
- [Pixel Units](ui/ts-pixel-units.md)
- [Types](ui/ts-types.md)
- Declarative Syntax
- [Overview](ui/ts-syntax-intro.md)
- General UI Description Specifications
- [Basic Concepts](ui/ts-general-ui-concepts.md)
- Declarative UI Description Specifications
- [Configuration Without Parameters](ui/ts-parameterless-configuration.md)
- [Configuration with Mandatory Parameters](ui/ts-configuration-with-mandatory-parameters.md)
- [Attribute Configuration](ui/ts-attribution-configuration.md)
- [Event Configuration](ui/ts-event-configuration.md)
- [Child Component Configuration](ui/ts-child-component-configuration.md)
- Componentization
- [@Component](ui/ts-component-based-component.md)
- [@Entry](ui/ts-component-based-entry.md)
- [@Preview](ui/ts-component-based-preview.md)
- [@Builder](ui/ts-component-based-builder.md)
- [@Extend](ui/ts-component-based-extend.md)
- [@CustomDialog](ui/ts-component-based-customdialog.md)
- [@Styles](ui/ts-component-based-styles.md)
- About UI State Management
- [Basic Concepts](ui/ts-ui-state-mgmt-concepts.md)
- Managing Component States
- [@State](ui/ts-component-states-state.md)
- [@Prop](ui/ts-component-states-prop.md)
- [@Link](ui/ts-component-states-link.md)
- Managing Application States
- [AppStorage](ui/ts-application-states-appstorage.md)
- [LocalStorage](ui/ui-ts-local-storage.md)
- [PersistentStorage](ui/ts-application-states-apis-persistentstorage.md)
- [Environment](ui/ts-application-states-apis-environment.md)
- Managing Other States
- [@Observed and @ObjectLink](ui/ts-other-states-observed-objectlink.md)
- [@Consume and @Provide](ui/ts-other-states-consume-provide.md)
- [@Watch](ui/ts-other-states-watch.md)
- About Rendering Control Syntax
- [if/else](ui/ts-rending-control-syntax-if-else.md)
- [ForEach](ui/ts-rending-control-syntax-foreach.md)
- [LazyForEach](ui/ts-rending-control-syntax-lazyforeach.md)
- About @Component
- [build Function](ui/ts-function-build.md)
- [Initialization of Custom Components' Member Variables](ui/ts-custom-component-initialization.md)
- [Custom Component Lifecycle Callbacks](ui/ts-custom-component-lifecycle-callbacks.md)
- [Component Creation and Re-initialization](ui/ts-component-creation-re-initialization.md)
- [About Syntactic Sugar](ui/ts-syntactic-sugar.md)
- Common Component Development Guidelines
- [Button](ui/ui-ts-basic-components-button.md)
- [Web](ui/ui-ts-components-web.md)
- Common Layout Development Guidelines
- [Flex Layout](ui/ui-ts-layout-flex.md)
- [Grid Layout](ui/ui-ts-layout-grid-container.md)
- [Media Query](ui/ui-ts-layout-mediaquery.md)
- Experiencing the Declarative UI
- [Creating a Declarative UI Project](ui/ui-ts-creating-project.md)
- [Getting to Know Components](ui/ui-ts-components.md)
- [Creating a Simple Page](ui/ui-ts-creating-simple-page.md)
- Defining Page Layout and Connection
- [Building a Food Data Model](ui/ui-ts-building-data-model.md)
- [Building a Food Category List Layout](ui/ui-ts-building-category-list-layout.md)
- [Building a Food Category Grid Layout](ui/ui-ts-building-category-grid-layout.md)
- [Implementing Page Redirection and Data Transmission](ui/ui-ts-page-redirection-data-transmission.md)
- Common Event and Notification - Common Event and Notification
- [Common Event and Notification Overview](notification/notification-brief.md) - [Common Event and Notification Overview](notification/notification-brief.md)
- [Common Event Development](notification/common-event.md) - [Common Event Development](notification/common-event.md)
- [Notification Development](notification/notification-guidelines.md) - [Notification Development](notification/notification-guidelines.md)
...@@ -202,7 +202,7 @@ ...@@ -202,7 +202,7 @@
- [WebGL Overview](webgl/webgl-overview.md) - [WebGL Overview](webgl/webgl-overview.md)
- [WebGL Development](webgl/webgl-guidelines.md) - [WebGL Development](webgl/webgl-guidelines.md)
- Media - Media
- Audio - Audio
- [Audio Overview](media/audio-overview.md) - [Audio Overview](media/audio-overview.md)
- [Audio Playback Development](media/audio-playback.md) - [Audio Playback Development](media/audio-playback.md)
...@@ -220,7 +220,7 @@ ...@@ -220,7 +220,7 @@
- Camera - Camera
- [Camera Development](media/camera.md) - [Camera Development](media/camera.md)
- Security - Security
- Access Control - Access Control
- [Access Control Overview](security/accesstoken-overview.md) - [Access Control Overview](security/accesstoken-overview.md)
- [Access Control Development](security/accesstoken-guidelines.md) - [Access Control Development](security/accesstoken-guidelines.md)
...@@ -316,108 +316,6 @@ ...@@ -316,108 +316,6 @@
- [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md)
- [Codelabs](https://gitee.com/openharmony/codelabs) - [Codelabs](https://gitee.com/openharmony/codelabs)
- API References - API References
- Component Reference (JavaScript-based Web-like Development Paradigm)
- Universal Component Information
- [Universal Attributes](reference/arkui-js/js-components-common-attributes.md)
- [Universal Styles](reference/arkui-js/js-components-common-styles.md)
- [Universal Events](reference/arkui-js/js-components-common-events.md)
- [Universal Methods](reference/arkui-js/js-components-common-methods.md)
- [Animation Styles](reference/arkui-js/js-components-common-animation.md)
- [Gradient Styles](reference/arkui-js/js-components-common-gradient.md)
- [Transition Styles](reference/arkui-js/js-components-common-transition.md)
- [Media Query](reference/arkui-js/js-components-common-mediaquery.md)
- [Custom Font Styles](reference/arkui-js/js-components-common-customizing-font.md)
- [Atomic Layout](reference/arkui-js/js-components-common-atomic-layout.md)
- Container Component
- [badge](reference/arkui-js/js-components-container-badge.md)
- [dialog](reference/arkui-js/js-components-container-dialog.md)
- [div](reference/arkui-js/js-components-container-div.md)
- [form](reference/arkui-js/js-components-container-form.md)
- [list](reference/arkui-js/js-components-container-list.md)
- [list-item](reference/arkui-js/js-components-container-list-item.md)
- [list-item-group](reference/arkui-js/js-components-container-list-item-group.md)
- [panel](reference/arkui-js/js-components-container-panel.md)
- [popup](reference/arkui-js/js-components-container-popup.md)
- [refresh](reference/arkui-js/js-components-container-refresh.md)
- [stack](reference/arkui-js/js-components-container-stack.md)
- [stepper](reference/arkui-js/js-components-container-stepper.md)
- [stepper-item](reference/arkui-js/js-components-container-stepper-item.md)
- [swiper](reference/arkui-js/js-components-container-swiper.md)
- [tabs](reference/arkui-js/js-components-container-tabs.md)
- [tab-bar](reference/arkui-js/js-components-container-tab-bar.md)
- [tab-content](reference/arkui-js/js-components-container-tab-content.md)
- Basic Components
- [button](reference/arkui-js/js-components-basic-button.md)
- [chart](reference/arkui-js/js-components-basic-chart.md)
- [divider](reference/arkui-js/js-components-basic-divider.md)
- [image](reference/arkui-js/js-components-basic-image.md)
- [image-animator](reference/arkui-js/js-components-basic-image-animator.md)
- [input](reference/arkui-js/js-components-basic-input.md)
- [label](reference/arkui-js/js-components-basic-label.md)
- [marquee](reference/arkui-js/js-components-basic-marquee.md)
- [menu](reference/arkui-js/js-components-basic-menu.md)
- [option](reference/arkui-js/js-components-basic-option.md)
- [picker](reference/arkui-js/js-components-basic-picker.md)
- [picker-view](reference/arkui-js/js-components-basic-picker-view.md)
- [piece](reference/arkui-js/js-components-basic-piece.md)
- [progress](reference/arkui-js/js-components-basic-progress.md)
- [qrcode](reference/arkui-js/js-components-basic-qrcode.md)
- [rating](reference/arkui-js/js-components-basic-rating.md)
- [richtext](reference/arkui-js/js-components-basic-richtext.md)
- [search](reference/arkui-js/js-components-basic-search.md)
- [select](reference/arkui-js/js-components-basic-select.md)
- [slider](reference/arkui-js/js-components-basic-slider.md)
- [span](reference/arkui-js/js-components-basic-span.md)
- [switch](reference/arkui-js/js-components-basic-switch.md)
- [text](reference/arkui-js/js-components-basic-text.md)
- [textarea](reference/arkui-js/js-components-basic-textarea.md)
- [toolbar](reference/arkui-js/js-components-basic-toolbar.md)
- [toolbar-item](reference/arkui-js/js-components-basic-toolbar-item.md)
- [toggle](reference/arkui-js/js-components-basic-toggle.md)
- [web](reference/arkui-js/js-components-basic-web.md)
- [xcomponent](reference/arkui-js/js-components-basic-xcomponent.md)
- Media Components
- [video](reference/arkui-js/js-components-media-video.md)
- Canvas Components
- [canvas](reference/arkui-js/js-components-canvas-canvas.md)
- [CanvasRenderingContext2D](reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md)
- [Image](reference/arkui-js/js-components-canvas-image.md)
- [CanvasGradient](reference/arkui-js/js-components-canvas-canvasgradient.md)
- [ImageData](reference/arkui-js/js-components-canvas-imagedata.md)
- [Path2D](reference/arkui-js/js-components-canvas-path2d.md)
- [ImageBitmap](reference/arkui-js/js-components-canvas-imagebitmap.md)
- [OffscreenCanvas](reference/arkui-js/js-components-canvas-offscreencanvas.md)
- [OffscreenCanvasRenderingContext2D](reference/arkui-js/js-offscreencanvasrenderingcontext2d.md)
- Grid Components
- [Basic Concepts](reference/arkui-js/js-components-grid-basic-concepts.md)
- [grid-container](reference/arkui-js/js-components-grid-container.md)
- [grid-row](reference/arkui-js/js-components-grid-row.md)
- [grid-col](reference/arkui-js/js-components-grid-col.md)
- SVG Components
- [Universal Attributes](reference/arkui-js/js-components-svg-common-attributes.md)
- [svg](reference/arkui-js/js-components-svg.md)
- [rect](reference/arkui-js/js-components-svg-rect.md)
- [circle](reference/arkui-js/js-components-svg-circle.md)
- [ellipse](reference/arkui-js/js-components-svg-ellipse.md)
- [path](reference/arkui-js/js-components-svg-path.md)
- [line](reference/arkui-js/js-components-svg-line.md)
- [polyline](reference/arkui-js/js-components-svg-polyline.md)
- [polygon](reference/arkui-js/js-components-svg-polygon.md)
- [text](reference/arkui-js/js-components-svg-text.md)
- [tspan](reference/arkui-js/js-components-svg-tspan.md)
- [textPath](reference/arkui-js/js-components-svg-textpath.md)
- [animate](reference/arkui-js/js-components-svg-animate.md)
- [animateMotion](reference/arkui-js/js-components-svg-animatemotion.md)
- [animateTransform](reference/arkui-js/js-components-svg-animatetransform.md)
- Custom Components
- [Basic Usage](reference/arkui-js/js-components-custom-basic-usage.md)
- [Style Inheritance](reference/arkui-js/js-components-custom-style.md)
- [Custom Events](reference/arkui-js/js-components-custom-events.md)
- [props](reference/arkui-js/js-components-custom-props.md)
- [Event Parameter](reference/arkui-js/js-components-custom-event-parameter.md)
- [slot](reference/arkui-js/js-components-custom-slot.md)
- [Lifecycle Definition](reference/arkui-js/js-components-custom-lifecycle.md)
- [Data Type Attributes](reference/arkui-js/js-appendix-types.md)
- Component Reference (TypeScript-based Declarative Development Paradigm) - Component Reference (TypeScript-based Declarative Development Paradigm)
- Universal Component Information - Universal Component Information
- Universal Events - Universal Events
...@@ -571,6 +469,108 @@ ...@@ -571,6 +469,108 @@
- [Text Picker Dialog Box](reference/arkui-ts/ts-methods-textpicker-dialog.md) - [Text Picker Dialog Box](reference/arkui-ts/ts-methods-textpicker-dialog.md)
- [Menu](reference/arkui-ts/ts-methods-menu.md) - [Menu](reference/arkui-ts/ts-methods-menu.md)
- [Built-in Enums](reference/arkui-ts/ts-appendix-enums.md) - [Built-in Enums](reference/arkui-ts/ts-appendix-enums.md)
- Component Reference (JavaScript-based Web-like Development Paradigm)
- Universal Component Information
- [Universal Attributes](reference/arkui-js/js-components-common-attributes.md)
- [Universal Styles](reference/arkui-js/js-components-common-styles.md)
- [Universal Events](reference/arkui-js/js-components-common-events.md)
- [Universal Methods](reference/arkui-js/js-components-common-methods.md)
- [Animation Styles](reference/arkui-js/js-components-common-animation.md)
- [Gradient Styles](reference/arkui-js/js-components-common-gradient.md)
- [Transition Styles](reference/arkui-js/js-components-common-transition.md)
- [Media Query](reference/arkui-js/js-components-common-mediaquery.md)
- [Custom Font Styles](reference/arkui-js/js-components-common-customizing-font.md)
- [Atomic Layout](reference/arkui-js/js-components-common-atomic-layout.md)
- Container Component
- [badge](reference/arkui-js/js-components-container-badge.md)
- [dialog](reference/arkui-js/js-components-container-dialog.md)
- [div](reference/arkui-js/js-components-container-div.md)
- [form](reference/arkui-js/js-components-container-form.md)
- [list](reference/arkui-js/js-components-container-list.md)
- [list-item](reference/arkui-js/js-components-container-list-item.md)
- [list-item-group](reference/arkui-js/js-components-container-list-item-group.md)
- [panel](reference/arkui-js/js-components-container-panel.md)
- [popup](reference/arkui-js/js-components-container-popup.md)
- [refresh](reference/arkui-js/js-components-container-refresh.md)
- [stack](reference/arkui-js/js-components-container-stack.md)
- [stepper](reference/arkui-js/js-components-container-stepper.md)
- [stepper-item](reference/arkui-js/js-components-container-stepper-item.md)
- [swiper](reference/arkui-js/js-components-container-swiper.md)
- [tabs](reference/arkui-js/js-components-container-tabs.md)
- [tab-bar](reference/arkui-js/js-components-container-tab-bar.md)
- [tab-content](reference/arkui-js/js-components-container-tab-content.md)
- Basic Components
- [button](reference/arkui-js/js-components-basic-button.md)
- [chart](reference/arkui-js/js-components-basic-chart.md)
- [divider](reference/arkui-js/js-components-basic-divider.md)
- [image](reference/arkui-js/js-components-basic-image.md)
- [image-animator](reference/arkui-js/js-components-basic-image-animator.md)
- [input](reference/arkui-js/js-components-basic-input.md)
- [label](reference/arkui-js/js-components-basic-label.md)
- [marquee](reference/arkui-js/js-components-basic-marquee.md)
- [menu](reference/arkui-js/js-components-basic-menu.md)
- [option](reference/arkui-js/js-components-basic-option.md)
- [picker](reference/arkui-js/js-components-basic-picker.md)
- [picker-view](reference/arkui-js/js-components-basic-picker-view.md)
- [piece](reference/arkui-js/js-components-basic-piece.md)
- [progress](reference/arkui-js/js-components-basic-progress.md)
- [qrcode](reference/arkui-js/js-components-basic-qrcode.md)
- [rating](reference/arkui-js/js-components-basic-rating.md)
- [richtext](reference/arkui-js/js-components-basic-richtext.md)
- [search](reference/arkui-js/js-components-basic-search.md)
- [select](reference/arkui-js/js-components-basic-select.md)
- [slider](reference/arkui-js/js-components-basic-slider.md)
- [span](reference/arkui-js/js-components-basic-span.md)
- [switch](reference/arkui-js/js-components-basic-switch.md)
- [text](reference/arkui-js/js-components-basic-text.md)
- [textarea](reference/arkui-js/js-components-basic-textarea.md)
- [toolbar](reference/arkui-js/js-components-basic-toolbar.md)
- [toolbar-item](reference/arkui-js/js-components-basic-toolbar-item.md)
- [toggle](reference/arkui-js/js-components-basic-toggle.md)
- [web](reference/arkui-js/js-components-basic-web.md)
- [xcomponent](reference/arkui-js/js-components-basic-xcomponent.md)
- Media Components
- [video](reference/arkui-js/js-components-media-video.md)
- Canvas Components
- [canvas](reference/arkui-js/js-components-canvas-canvas.md)
- [CanvasRenderingContext2D](reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md)
- [Image](reference/arkui-js/js-components-canvas-image.md)
- [CanvasGradient](reference/arkui-js/js-components-canvas-canvasgradient.md)
- [ImageData](reference/arkui-js/js-components-canvas-imagedata.md)
- [Path2D](reference/arkui-js/js-components-canvas-path2d.md)
- [ImageBitmap](reference/arkui-js/js-components-canvas-imagebitmap.md)
- [OffscreenCanvas](reference/arkui-js/js-components-canvas-offscreencanvas.md)
- [OffscreenCanvasRenderingContext2D](reference/arkui-js/js-offscreencanvasrenderingcontext2d.md)
- Grid Components
- [Basic Concepts](reference/arkui-js/js-components-grid-basic-concepts.md)
- [grid-container](reference/arkui-js/js-components-grid-container.md)
- [grid-row](reference/arkui-js/js-components-grid-row.md)
- [grid-col](reference/arkui-js/js-components-grid-col.md)
- SVG Components
- [Universal Attributes](reference/arkui-js/js-components-svg-common-attributes.md)
- [svg](reference/arkui-js/js-components-svg.md)
- [rect](reference/arkui-js/js-components-svg-rect.md)
- [circle](reference/arkui-js/js-components-svg-circle.md)
- [ellipse](reference/arkui-js/js-components-svg-ellipse.md)
- [path](reference/arkui-js/js-components-svg-path.md)
- [line](reference/arkui-js/js-components-svg-line.md)
- [polyline](reference/arkui-js/js-components-svg-polyline.md)
- [polygon](reference/arkui-js/js-components-svg-polygon.md)
- [text](reference/arkui-js/js-components-svg-text.md)
- [tspan](reference/arkui-js/js-components-svg-tspan.md)
- [textPath](reference/arkui-js/js-components-svg-textpath.md)
- [animate](reference/arkui-js/js-components-svg-animate.md)
- [animateMotion](reference/arkui-js/js-components-svg-animatemotion.md)
- [animateTransform](reference/arkui-js/js-components-svg-animatetransform.md)
- Custom Components
- [Basic Usage](reference/arkui-js/js-components-custom-basic-usage.md)
- [Style Inheritance](reference/arkui-js/js-components-custom-style.md)
- [Custom Events](reference/arkui-js/js-components-custom-events.md)
- [props](reference/arkui-js/js-components-custom-props.md)
- [Event Parameter](reference/arkui-js/js-components-custom-event-parameter.md)
- [slot](reference/arkui-js/js-components-custom-slot.md)
- [Lifecycle Definition](reference/arkui-js/js-components-custom-lifecycle.md)
- [Data Type Attributes](reference/arkui-js/js-appendix-types.md)
- APIs - APIs
- [API Reference Document Description](reference/apis/development-intro.md) - [API Reference Document Description](reference/apis/development-intro.md)
- Ability Framework - Ability Framework
......
...@@ -42,8 +42,8 @@ ...@@ -42,8 +42,8 @@
- [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md) - [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md)
- [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md) - [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md)
- API参考 - API参考
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md) - [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md)
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- 接口 - 接口
- [JS及TS API参考](reference/apis/Readme-CN.md) - [JS及TS API参考](reference/apis/Readme-CN.md)
- Native API - Native API
......
...@@ -54,11 +54,14 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。 ...@@ -54,11 +54,14 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。
API参考提供了OpenHarmony全量组件和接口的参考文档,可以帮助开发者快速查找到指定接口的详细描述和调用方法。 API参考提供了OpenHarmony全量组件和接口的参考文档,可以帮助开发者快速查找到指定接口的详细描述和调用方法。
内容包括: 内容包括:
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md) - [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md)
- 接口参考
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- 接口参考
- [JS及TS API参考](reference/apis/Readme-CN.md) - [JS及TS API参考](reference/apis/Readme-CN.md)
- Native API - Native API
- [Native API参考](reference/native-apis/Readme-CN.md) - [Native API参考](reference/native-apis/Readme-CN.md)
- [标准库](reference/native-lib/third_party_libc/musl.md) - [标准库](reference/native-lib/third_party_libc/musl.md)
- [Node_API](reference/native-lib/third_party_napi/napi.md) - [Node_API](reference/native-lib/third_party_napi/napi.md)
......
...@@ -55,6 +55,12 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。 ...@@ -55,6 +55,12 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。
API参考提供了OpenHarmony全量组件和接口的参考文档,可以帮助开发者快速查找到指定接口的详细描述和调用方法。 API参考提供了OpenHarmony全量组件和接口的参考文档,可以帮助开发者快速查找到指定接口的详细描述和调用方法。
内容包括: 内容包括:
- [组件参考(基于TS扩展的声明式开发范式)](reference/arkui-ts/Readme-CN.md)
- [组件参考(基于JS扩展的类Web开发范式)](reference/arkui-js/Readme-CN.md)
- [接口参考(JS及TS API)](reference/apis/js-apis-DataUriUtils.md) - [接口参考(JS及TS API)](reference/apis/js-apis-DataUriUtils.md)
- 接口参考(Native API) - 接口参考(Native API)
- [OpenHarmony Native API](reference/native-apis/_o_h___native_x_component.md) - [OpenHarmony Native API](reference/native-apis/_o_h___native_x_component.md)
......
# 开发参考 # 开发参考
- [基于JS扩展的类Web开发范式](arkui-js/Readme-CN.md) - [组件参考(基于TS扩展的声明式开发范式)](arkui-ts/Readme-CN.md)
- [基于TS扩展的声明式开发范式](arkui-ts/Readme-CN.md) - [组件参考(基于JS扩展的类Web开发范式)](arkui-js/Readme-CN.md)
- [接口参考(JS及TS API)](apis/Readme-CN.md) - [接口参考(JS及TS API)](apis/Readme-CN.md)
- 接口参考(Native API) - 接口参考(Native API)
- [OpenHarmony Native API](./native-apis/Readme-CN.md) - [OpenHarmony Native API](./native-apis/Readme-CN.md)
......
...@@ -4,13 +4,14 @@ ...@@ -4,13 +4,14 @@
开发者在开发应用时,通过复写该模块的接口,在延迟任务触发的时候,系统会通过接口回调应用,开发者在回调接口里面可以处理自己的任务逻辑。 开发者在开发应用时,通过复写该模块的接口,在延迟任务触发的时候,系统会通过接口回调应用,开发者在回调接口里面可以处理自己的任务逻辑。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```ts
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility' import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
``` ```
...@@ -24,13 +25,13 @@ onWorkStart(work: workScheduler.WorkInfo): void ...@@ -24,13 +25,13 @@ onWorkStart(work: workScheduler.WorkInfo): void
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- | | ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 | | work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
**示例:** **示例:**
``` ```ts
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStart(workInfo) { onWorkStart(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo)); console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
...@@ -48,14 +49,14 @@ onWorkStop(work: workScheduler.WorkInfo): void ...@@ -48,14 +49,14 @@ onWorkStop(work: workScheduler.WorkInfo): void
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- | | ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 | | work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
**示例:** **示例:**
``` ```ts
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility { export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStop(workInfo) { onWorkStop(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo)); console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
......
...@@ -3,13 +3,13 @@ ...@@ -3,13 +3,13 @@
本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。 本模块提供组件动画效果,包括定义动画、启动动画和以相反的顺序播放动画等。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```js
import animator from '@ohos.animator'; import animator from '@ohos.animator';
``` ```
...@@ -23,18 +23,18 @@ createAnimator(options: AnimatorOptions): AnimatorResult ...@@ -23,18 +23,18 @@ createAnimator(options: AnimatorOptions): AnimatorResult
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------------------------------- | ---- | ------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | --------------------------------- | ------------- |
| [AnimatorResult](#animatorresult) | Animator结果接口。 | | [AnimatorResult](#animatorresult) | Animator结果接口。 |
**示例:** **示例:**
``` ```html
<!-- hml --> <!-- hml -->
<div class="container"> <div class="container">
<div class="Animation" style="height: {{divHeight}}px; width: {{divWidth}}px; background-color: red;" onclick="Show"> <div class="Animation" style="height: {{divHeight}}px; width: {{divWidth}}px; background-color: red;" onclick="Show">
...@@ -42,7 +42,7 @@ createAnimator(options: AnimatorOptions): AnimatorResult ...@@ -42,7 +42,7 @@ createAnimator(options: AnimatorOptions): AnimatorResult
</div> </div>
``` ```
``` ```js
// js // js
export default { export default {
data : { data : {
...@@ -94,12 +94,12 @@ update(options: AnimatorOptions): void ...@@ -94,12 +94,12 @@ update(options: AnimatorOptions): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ------- | ----------------------------------- | ---- | ------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。| | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 |
**示例:** **示例:**
``` ```js
animator.update(options); animator.update(options);
``` ```
...@@ -112,7 +112,7 @@ play(): void ...@@ -112,7 +112,7 @@ play(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.play(); animator.play();
``` ```
...@@ -125,7 +125,7 @@ finish(): void ...@@ -125,7 +125,7 @@ finish(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.finish(); animator.finish();
``` ```
...@@ -138,7 +138,7 @@ pause(): void ...@@ -138,7 +138,7 @@ pause(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.pause(); animator.pause();
``` ```
...@@ -151,7 +151,7 @@ cancel(): void ...@@ -151,7 +151,7 @@ cancel(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.cancel(); animator.cancel();
``` ```
...@@ -164,7 +164,7 @@ reverse(): void ...@@ -164,7 +164,7 @@ reverse(): void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.reverse(); animator.reverse();
``` ```
...@@ -177,12 +177,12 @@ onframe: (progress: number) => void ...@@ -177,12 +177,12 @@ onframe: (progress: number) => void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | ------ | ---- | -------- |
| progress | number | 是 | 动画的当前进度。| | progress | number | 是 | 动画的当前进度。 |
**示例:** **示例:**
``` ```js
animator.onframe(); animator.onframe();
``` ```
...@@ -195,7 +195,7 @@ onfinish: () => void ...@@ -195,7 +195,7 @@ onfinish: () => void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.onfinish(); animator.onfinish();
``` ```
...@@ -208,7 +208,7 @@ oncancel: () => void ...@@ -208,7 +208,7 @@ oncancel: () => void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.oncancel(); animator.oncancel();
``` ```
...@@ -221,7 +221,7 @@ onrepeat: () => void ...@@ -221,7 +221,7 @@ onrepeat: () => void
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
**示例:** **示例:**
``` ```js
animator.onrepeat(); animator.onrepeat();
``` ```
...@@ -231,13 +231,13 @@ animator.onrepeat(); ...@@ -231,13 +231,13 @@ animator.onrepeat();
**系统能力:** SystemCapability.ArkUI.ArkUI.Full **系统能力:** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| duration | number | 是 | 动画播放的时长,单位毫秒,默认为0。 | | duration | number | 是 | 动画播放的时长,单位毫秒,默认为0。 |
| easing | string | 是 | 动画插值曲线,默认为'ease'。 | | easing | string | 是 | 动画插值曲线,默认为'ease'。 |
| delay | number | 是 | 动画延时播放时长,单位毫秒,默认为0,即不延时。 | | delay | number | 是 | 动画延时播放时长,单位毫秒,默认为0,即不延时。 |
| fill | "none" \| "forwards" \| "backwards" \| "both" | 是 | 动画执行后是否恢复到初始状态,默认值为"none"。动画执行后,动画结束时的状态(在最后一个关键帧中定义)将保留。 | | fill | "none" \| "forwards" \| "backwards" \| "both" | 是 | 动画执行后是否恢复到初始状态,默认值为"none"。动画执行后,动画结束时的状态(在最后一个关键帧中定义)将保留。 |
| direction | "normal" \| "reverse" \| "alternate" \| "alternate-reverse" | 是 | 动画播放模式,默认值"normal"。| | direction | "normal" \| "reverse" \| "alternate" \| "alternate-reverse" | 是 | 动画播放模式,默认值"normal"。 |
| iterations | number | 是 | 动画播放次数,默认值1。设置为0时不播放,设置为-1时无限次播放。 | | iterations | number | 是 | 动画播放次数,默认值1。设置为0时不播放,设置为-1时无限次播放。 |
| begin | number | 是 | 动画插值起点,默认为0。 | | begin | number | 是 | 动画插值起点,默认为0。 |
| end | number | 是 | 动画插值终点,默认为1。 | | end | number | 是 | 动画插值终点,默认为1。 |
...@@ -8,13 +8,13 @@ ...@@ -8,13 +8,13 @@
应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。 应用中存在用户能够直观感受到的且需要一直在后台运行的业务时(如,后台播放音乐),可以使用长时任务机制。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```js
import backgroundTaskManager from '@ohos.backgroundTaskManager'; import backgroundTaskManager from '@ohos.backgroundTaskManager';
``` ```
...@@ -143,12 +143,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -143,12 +143,12 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ------------------------ | | --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) |
| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | | bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 |
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击后跳转的界面。 | | wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击后跳转的界面。 |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 |
**示例** **示例**
```js ```js
...@@ -195,11 +195,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want ...@@ -195,11 +195,11 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------- | ---- | ----------------------- | | --------- | ---------------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) |
| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | | bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 |
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 | | wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -244,10 +244,10 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo ...@@ -244,10 +244,10 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ---------------------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md) |
| callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback形式返回启动长时任务的结果。 |
**示例** **示例**
```js ```js
...@@ -275,8 +275,8 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt; ...@@ -275,8 +275,8 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------- | ---- | --------- | | ------- | ------- | ---- | ---------------------------------------- |
| context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | context | Context | 是 | 应用运行的上下文。<br>FA模型的应用Context定义见[Context](js-apis-Context.md)<br>Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 |
**返回值** **返回值**
...@@ -301,7 +301,7 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() ...@@ -301,7 +301,7 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
延迟挂起信息。 延迟挂起信息。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- | | --------------- | ------ | ---- | ---------------------------------------- |
...@@ -311,16 +311,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() ...@@ -311,16 +311,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
## BackgroundMode<sup>8+</sup> ## BackgroundMode<sup>8+</sup>
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 | | 参数名 | 参数值 | 描述 |
| ----------------------- | ------ | ------------------------------------------------------------ | | ----------------------- | ---- | --------------------- |
| DATA_TRANSFER | 1 | 数据传输 | | DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 | | AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 | | AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 | | LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 | | BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 | | MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关<br />**系统API**:此接口为系统接口,三方应用不支持调用。 | | WIFI_INTERACTION | 7 | WLAN相关<br />此接口为系统接口。 |
| VOIP | 8 | 音视频通话<br />**系统API**:此接口为系统接口,三方应用不支持调用。 | | VOIP | 8 | 音视频通话<br />此接口为系统接口。 |
| TASK_KEEPING | 9 | 计算任务(仅在特定设备生效) | | TASK_KEEPING | 9 | 计算任务(仅在特定设备生效) |
\ No newline at end of file \ No newline at end of file
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> 本模块接口均为系统接口,三方应用不支持调用 > 本模块接口均为系统接口。
## 导入模块 ## 导入模块
......
...@@ -3,14 +3,14 @@ ...@@ -3,14 +3,14 @@
分布式任务管理模块提供跨设备系统任务管理能力,包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表操作。 分布式任务管理模块提供跨设备系统任务管理能力,包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表操作。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> 本模块接口为系统接口。 > 本模块接口为系统接口。
## 导入模块 ## 导入模块
``` ```js
import distributedMissionManager from '@ohos.distributedMissionManager' import distributedMissionManager from '@ohos.distributedMissionManager'
``` ```
...@@ -27,11 +27,11 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, ...@@ -27,11 +27,11 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback,
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听设备信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听设备信息。 |
| options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 | | options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例:** **示例:**
...@@ -71,16 +71,16 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): ...@@ -71,16 +71,16 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback):
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ---------------------------------------- | ---- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 | | options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 | | Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例:** **示例:**
...@@ -125,10 +125,10 @@ unregisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback& ...@@ -125,10 +125,10 @@ unregisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例:** **示例:**
...@@ -154,15 +154,15 @@ unregisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt; ...@@ -154,15 +154,15 @@ unregisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------------------- | ---- | ----- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 | | Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例:** **示例:**
...@@ -190,10 +190,10 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt; ...@@ -190,10 +190,10 @@ startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ------------------------------------- | ---- | --------- |
| parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 | | parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例:** **示例:**
...@@ -220,15 +220,15 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt; ...@@ -220,15 +220,15 @@ startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | ------------------------------------- | ---- | ----- |
| parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 | | parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 | | Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例:** **示例:**
...@@ -258,10 +258,10 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt; ...@@ -258,10 +258,10 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例:** **示例:**
...@@ -286,15 +286,15 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt; ...@@ -286,15 +286,15 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | --------- | --------------------------------------- | ---- | ----- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 | | parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------------------- | ---------------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 | | Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例:** **示例:**
...@@ -314,32 +314,32 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt; ...@@ -314,32 +314,32 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
表示开始同步后,建立的回调函数。 表示开始同步后,建立的回调函数。
**系统能力**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | --------------------- | -------- | ---- | ---- | ------------------ |
| notifyMissionsChanged | function | 是 | 否 | 通知任务变化,返回设备ID。| | notifyMissionsChanged | function | 是 | 否 | 通知任务变化,返回设备ID。 |
| notifySnapshot | function | 是 | 否 | 通知快照变化,返回设备ID,任务ID | | notifySnapshot | function | 是 | 否 | 通知快照变化,返回设备ID,任务ID |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接,返回设备ID,网络状态 | | notifyNetDisconnect | function | 是 | 否 | 通知断开连接,返回设备ID,网络状态 |
## MissionParameter ## MissionParameter
表示同步时所需参数的枚举。 表示同步时所需参数的枚举。
**系统能力**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------- | ---- | ---- | ----------- |
| deviceId | string | 是 | 是 | 表示设备ID。| | deviceId | string | 是 | 是 | 表示设备ID。 |
| fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 | | fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 |
| tag | number | 是 | 是 | 表示特定的标签。 | | tag | number | 是 | 是 | 表示特定的标签。 |
## MissionDeviceInfo ## MissionDeviceInfo
表示注册监听时所需参数的枚举。 表示注册监听时所需参数的枚举。
**系统能力**以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission **系统能力**:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---- | ------- |
| deviceId | string | 是 | 是 | 表示设备ID。| | deviceId | string | 是 | 是 | 表示设备ID。 |
\ No newline at end of file \ No newline at end of file
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。 本模块提供企业设备管理能力,使设备具备企业场景下所需的定制能力。
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -18,20 +18,18 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callba ...@@ -18,20 +18,18 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callba
以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。 以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ------------------ | | -------------- | ----------------------------------- | ---- | ------------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 | | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 | | type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否激活成功 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否激活成功 |
**示例** **示例**
...@@ -59,23 +57,19 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId ...@@ -59,23 +57,19 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId
以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。 以异步方法根据给定的包名和类名激活设备管理员应用,使用Callback形式返回是否激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
**系统能力:**
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------------- | | -------------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 | | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 | | type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否激活成功 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否激活成功 |
**示例** **示例**
...@@ -103,20 +97,18 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId ...@@ -103,20 +97,18 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId
以异步方法根据给定的包名和类名激活设备管理员应用,使用Promise形式返回是否激活成功。 以异步方法根据给定的包名和类名激活设备管理员应用,使用Promise形式返回是否激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------------- | | -------------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 | | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 | | type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
**返回值:** **返回值:**
...@@ -149,18 +141,16 @@ disableAdmin(admin: Want, callback: AsyncCallback\<boolean>): void ...@@ -149,18 +141,16 @@ disableAdmin(admin: Want, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。 以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ------------------- | | -------- | ----------------------------------- | ---- | ------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
**示例** **示例**
...@@ -184,21 +174,17 @@ disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<boolean>): vo ...@@ -184,21 +174,17 @@ disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<boolean>): vo
以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。 以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Callback形式返回是否去激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ---------------------------- | | -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
**示例** **示例**
...@@ -222,18 +208,16 @@ disableAdmin(admin: Want, userId?: number): Promise\<boolean> ...@@ -222,18 +208,16 @@ disableAdmin(admin: Want, userId?: number): Promise\<boolean>
以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Promise形式返回是否去激活成功。 以异步方法根据给定的包名和类名将设备普通管理员应用去激活,使用Promise形式返回是否去激活成功。
**需要权限:** **需要权限:** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | --- | ---------------------------- | | ------ | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
**返回值:** **返回值:**
...@@ -261,15 +245,14 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void ...@@ -261,15 +245,14 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名将设备超级管理员应用去激活,使用Callback形式返回是否去激活成功。 以异步方法根据给定的包名将设备超级管理员应用去激活,使用Callback形式返回是否去激活成功。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | --- | ------------------- | | ---------- | ----------------------- | ---- | ------------------- |
| bundleName | String | 是 | 超级设备管理员应用的包名 | | bundleName | String | 是 | 超级设备管理员应用的包名 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
**示例** **示例**
...@@ -290,14 +273,13 @@ disableSuperAdmin(bundleName: String): Promise\<boolean> ...@@ -290,14 +273,13 @@ disableSuperAdmin(bundleName: String): Promise\<boolean>
以异步方法根据给定的包名将设备超级管理员应用去激活,使用Promise形式返回是否去激活成功。 以异步方法根据给定的包名将设备超级管理员应用去激活,使用Promise形式返回是否去激活成功。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | --- | ------------ | | ---------- | ------ | ---- | ------------ |
| bundleName | String | 是 | 超级设备管理员应用的包名 | | bundleName | String | 是 | 超级设备管理员应用的包名 |
**返回值:** **返回值:**
...@@ -322,15 +304,14 @@ isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void ...@@ -322,15 +304,14 @@ isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。 以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | -------------------- | | -------- | ----------------------------------- | ---- | -------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
**示例** **示例**
...@@ -354,17 +335,15 @@ isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>): ...@@ -354,17 +335,15 @@ isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>):
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。 以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Callback形式返回是否处于激活状态。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ---------------------------- | | -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
**示例** **示例**
...@@ -388,15 +367,14 @@ isAdminEnabled(admin: Want, userId?: number): Promise\<boolean> ...@@ -388,15 +367,14 @@ isAdminEnabled(admin: Want, userId?: number): Promise\<boolean>
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Promise形式返回是否处于激活状态。 以异步方法根据给定的包名和类名判断设备管理员应用是否被激活,使用Promise形式返回是否处于激活状态。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | --- | ---------------------------- | | ------ | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
**返回值:** **返回值:**
...@@ -424,15 +402,14 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void ...@@ -424,15 +402,14 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Callback形式返回是否处于激活状态。 以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Callback形式返回是否处于激活状态。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | --- | -------------------- | | ---------- | ----------------------- | ---- | -------------------- |
| bundleName | String | 是 | 设备管理员应用 | | bundleName | String | 是 | 设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 | | callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
**示例** **示例**
...@@ -453,14 +430,13 @@ isSuperAdmin(bundleName: String): Promise\<boolean> ...@@ -453,14 +430,13 @@ isSuperAdmin(bundleName: String): Promise\<boolean>
以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Promise形式返回是否处于激活状态。 以异步方法根据给定的包名判断设备超级管理员应用是否被激活,使用Promise形式返回是否处于激活状态。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | --- | --------- | | ---------- | ------ | ---- | --------- |
| bundleName | String | 是 | 超级设备管理员应用 | | bundleName | String | 是 | 超级设备管理员应用 |
**返回值:** **返回值:**
...@@ -485,14 +461,13 @@ getDeviceSettingsManager(callback: AsyncCallback&lt;DeviceSettingsManager&gt;): ...@@ -485,14 +461,13 @@ getDeviceSettingsManager(callback: AsyncCallback&lt;DeviceSettingsManager&gt;):
获取DeviceSettingsManager对象,使用callback形式返回DeviceSettingsManager对象。 获取DeviceSettingsManager对象,使用callback形式返回DeviceSettingsManager对象。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | --- | ----------------------------------- | | -------- | --------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback<DeviceSettingsManager&gt; | 是 | callback方式返回DeviceSettingsManager对象 | | callback | AsyncCallback<DeviceSettingsManager&gt; | 是 | callback方式返回DeviceSettingsManager对象 |
**示例:** **示例:**
...@@ -522,8 +497,7 @@ getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt; ...@@ -522,8 +497,7 @@ getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt;
获取DeviceSettingsManager对象,使用Promise形式返回DeviceSettingsManager对象。 获取DeviceSettingsManager对象,使用Promise形式返回DeviceSettingsManager对象。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**返回值:** **返回值:**
...@@ -555,16 +529,15 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCa ...@@ -555,16 +529,15 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCa
设置设备管理员应用的企业信息,使用callback形式返回是否设置成功。 设置设备管理员应用的企业信息,使用callback形式返回是否设置成功。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------- | | -------------- | ----------------------------------- | ---- | ---------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 | | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| callback | AsyncCallback\<boolean&gt; | 是 | callback方式返回是否设置企业信息成功 | | callback | AsyncCallback\<boolean&gt; | 是 | callback方式返回是否设置企业信息成功 |
**示例:** **示例:**
...@@ -591,15 +564,14 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise&lt;boole ...@@ -591,15 +564,14 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise&lt;boole
设置设备管理员应用的企业信息,使用Promise形式返回是否设置成功。 设置设备管理员应用的企业信息,使用Promise形式返回是否设置成功。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ------------ | | -------------- | ----------------------------------- | ---- | ------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 | | enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
**返回值:** **返回值:**
...@@ -632,15 +604,14 @@ getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): v ...@@ -632,15 +604,14 @@ getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): v
获取设备管理员应用的企业信息,使用callback形式返回设备管理员应用的企业信息。 获取设备管理员应用的企业信息,使用callback形式返回设备管理员应用的企业信息。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | --- | ------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | 是 | callback方式返回设备管理员应用的企业信息 | | callback | AsyncCallback&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | 是 | callback方式返回设备管理员应用的企业信息 |
**示例:** **示例:**
...@@ -665,19 +636,18 @@ getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt; ...@@ -665,19 +636,18 @@ getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt;
获取设备管理员应用的企业信息,使用Promise形式返回设备管理员应用的企业信息。 获取设备管理员应用的企业信息,使用Promise形式返回设备管理员应用的企业信息。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
SystemCapability.Customization.EnterpriseDeviceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | --- | ------- | | ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 | | admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------------ | ------------------------- | | ---------------------------------------- | ------------------------- |
| Promise&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Promise方式返回设备管理员应用的企业信息对象 | | Promise&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Promise方式返回设备管理员应用的企业信息对象 |
**示例:** **示例:**
...@@ -699,20 +669,18 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => { ...@@ -699,20 +669,18 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
设备管理员应用的企业信息 设备管理员应用的企业信息
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
以下各项对应系统能力均为SystemCapability.Customization.EnterpriseDeviceManager
| 名称 | 读写属性 | 类型 | 必填 | 描述 | | 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | ---- | ------ | --- | ----------------- | | ----------- | ---- | ------ | ---- | ----------------- |
| name | 只读 | string | 是 | 表示设备管理员应用所属企业的名称。 | | name | 只读 | string | 是 | 表示设备管理员应用所属企业的名称。 |
| description | 只读 | string | 是 | 表示设备管理员应用所属企业的描述。 | | description | 只读 | string | 是 | 表示设备管理员应用所属企业的描述。 |
## AdminType ## AdminType
设备管理员应用的管理员类型。 设备管理员应用的管理员类型。
**系统能力:** **系统能力:** SystemCapability.Customization.EnterpriseDeviceManager
以下各项对应系统能力均为SystemCapability.Customization.EnterpriseDeviceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ----------------- | ---- | ----- | | ----------------- | ---- | ----- |
......
...@@ -3,15 +3,15 @@ ...@@ -3,15 +3,15 @@
本模块提供系统相关的或者增强的国际化能力,包括区域管理、电话号码处理、日历等,相关接口为ECMA 402标准中未定义的补充接口。 本模块提供系统相关的或者增强的国际化能力,包括区域管理、电话号码处理、日历等,相关接口为ECMA 402标准中未定义的补充接口。
[Intl模块](js-apis-intl.md)提供了ECMA 402标准定义的基础国际化接口,与本模块共同使用可提供完整地国际化支持能力。 [Intl模块](js-apis-intl.md)提供了ECMA 402标准定义的基础国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> - I18N模块包含国际化能力增强接口(未在ECMA 402中定义),包括区域管理、电话号码处理、日历等,国际化基础能力请参考[Intl模块](js-apis-intl.md)。 > - I18N模块包含国际化能力增强接口(未在ECMA 402中定义),包括区域管理、电话号码处理、日历等,国际化基础能力请参考[Intl模块](js-apis-intl.md)。
## 导入模块 ## 导入模块
``` ```js
import i18n from '@ohos.i18n'; import i18n from '@ohos.i18n';
``` ```
...@@ -37,7 +37,7 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st ...@@ -37,7 +37,7 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
| string | 指定语言的本地化显示文本。 | | string | 指定语言的本地化显示文本。 |
**示例:** **示例:**
``` ```js
i18n.getDisplayLanguage("zh", "en-GB", true); i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB"); i18n.getDisplayLanguage("zh", "en-GB");
``` ```
...@@ -64,7 +64,7 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri ...@@ -64,7 +64,7 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
| string | 指定国家的本地化显示文本。 | | string | 指定国家的本地化显示文本。 |
**示例:** **示例:**
``` ```js
i18n.getDisplayCountry("zh-CN", "en-GB", true); i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB"); i18n.getDisplayCountry("zh-CN", "en-GB");
``` ```
...@@ -89,7 +89,7 @@ isRTL(locale: string): boolean ...@@ -89,7 +89,7 @@ isRTL(locale: string): boolean
| boolean | true表示该locale从右至左显示语言;false表示该locale从左至右显示语言。 | | boolean | true表示该locale从右至左显示语言;false表示该locale从左至右显示语言。 |
**示例:** **示例:**
``` ```js
i18n.isRTL("zh-CN");// 中文不是RTL语言,返回false i18n.isRTL("zh-CN");// 中文不是RTL语言,返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言,返回true i18n.isRTL("ar-EG");// 阿语是RTL语言,返回true
``` ```
...@@ -109,7 +109,7 @@ getSystemLanguage(): string ...@@ -109,7 +109,7 @@ getSystemLanguage(): string
| string | 系统语言ID。 | | string | 系统语言ID。 |
**示例:** **示例:**
``` ```js
i18n.getSystemLanguage(); i18n.getSystemLanguage();
``` ```
...@@ -120,7 +120,7 @@ setSystemLanguage(language: string): boolean ...@@ -120,7 +120,7 @@ setSystemLanguage(language: string): boolean
设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。 设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。
接口为系统接口。 接口为系统接口。
**需要权限**:ohos.permission.UPDATE_CONFIGURATION **需要权限**:ohos.permission.UPDATE_CONFIGURATION
...@@ -137,7 +137,7 @@ setSystemLanguage(language: string): boolean ...@@ -137,7 +137,7 @@ setSystemLanguage(language: string): boolean
| boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 | | boolean | 返回true,表示系统语言设置成功;返回false,表示系统语言设置失败。 |
**示例:** **示例:**
``` ```js
i18n.setSystemLanguage('zh'); i18n.setSystemLanguage('zh');
``` ```
...@@ -148,9 +148,9 @@ getSystemLanguages(): Array&lt;string&gt; ...@@ -148,9 +148,9 @@ getSystemLanguages(): Array&lt;string&gt;
获取系统支持的语言列表。 获取系统支持的语言列表。
**系统能力**:SystemCapability.Global.I18n 此接口为系统接口。
**系统API**: 该接口为系统接口,三方应用不支持调用。 **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -158,7 +158,7 @@ getSystemLanguages(): Array&lt;string&gt; ...@@ -158,7 +158,7 @@ getSystemLanguages(): Array&lt;string&gt;
| Array&lt;string&gt; | 系统支持的语言ID列表。 | | Array&lt;string&gt; | 系统支持的语言ID列表。 |
**示例:** **示例:**
``` ```js
i18n.getSystemLanguages(); i18n.getSystemLanguages();
``` ```
...@@ -169,9 +169,9 @@ getSystemCountries(language: string): Array&lt;string&gt; ...@@ -169,9 +169,9 @@ getSystemCountries(language: string): Array&lt;string&gt;
获取针对输入语言系统支持的区域列表。 获取针对输入语言系统支持的区域列表。
**系统能力**:SystemCapability.Global.I18n 此接口为系统接口。
**系统API**: 该接口为系统接口,三方应用不支持调用。 **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
...@@ -184,7 +184,7 @@ getSystemCountries(language: string): Array&lt;string&gt; ...@@ -184,7 +184,7 @@ getSystemCountries(language: string): Array&lt;string&gt;
| Array&lt;string&gt; | 系统支持的区域ID列表。 | | Array&lt;string&gt; | 系统支持的区域ID列表。 |
**示例:** **示例:**
``` ```js
i18n.getSystemCountries('zh'); i18n.getSystemCountries('zh');
``` ```
...@@ -203,7 +203,7 @@ getSystemRegion(): string ...@@ -203,7 +203,7 @@ getSystemRegion(): string
| string | 系统地区ID。 | | string | 系统地区ID。 |
**示例:** **示例:**
``` ```js
i18n.getSystemRegion(); i18n.getSystemRegion();
``` ```
...@@ -214,7 +214,7 @@ setSystemRegion(region: string): boolean ...@@ -214,7 +214,7 @@ setSystemRegion(region: string): boolean
设置系统区域。 设置系统区域。
接口为系统接口。 接口为系统接口。
**需要权限**:ohos.permission.UPDATE_CONFIGURATION **需要权限**:ohos.permission.UPDATE_CONFIGURATION
...@@ -231,7 +231,7 @@ setSystemRegion(region: string): boolean ...@@ -231,7 +231,7 @@ setSystemRegion(region: string): boolean
| boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 | | boolean | 返回true,表示系统区域设置成功;返回false,表示系统区域设置失败。 |
**示例:** **示例:**
``` ```js
i18n.setSystemRegion('CN'); i18n.setSystemRegion('CN');
``` ```
...@@ -250,7 +250,7 @@ getSystemLocale(): string ...@@ -250,7 +250,7 @@ getSystemLocale(): string
| string | 系统区域ID。 | | string | 系统区域ID。 |
**示例:** **示例:**
``` ```js
i18n.getSystemLocale(); i18n.getSystemLocale();
``` ```
...@@ -261,7 +261,7 @@ setSystemLocale(locale: string): boolean ...@@ -261,7 +261,7 @@ setSystemLocale(locale: string): boolean
设置系统Locale。 设置系统Locale。
接口为系统接口。 接口为系统接口。
**需要权限**:ohos.permission.UPDATE_CONFIGURATION **需要权限**:ohos.permission.UPDATE_CONFIGURATION
...@@ -278,7 +278,7 @@ setSystemLocale(locale: string): boolean ...@@ -278,7 +278,7 @@ setSystemLocale(locale: string): boolean
| boolean | 返回true,表示系统Locale设置成功;返回false,表示系统Locale设置失败。 | | boolean | 返回true,表示系统Locale设置成功;返回false,表示系统Locale设置失败。 |
**示例:** **示例:**
``` ```js
i18n.setSystemLocale('zh-CN'); i18n.setSystemLocale('zh-CN');
``` ```
...@@ -289,9 +289,9 @@ isSuggested(language: string, region?: string): boolean ...@@ -289,9 +289,9 @@ isSuggested(language: string, region?: string): boolean
判断当前语言和区域是否匹配。 判断当前语言和区域是否匹配。
**系统能力**:SystemCapability.Global.I18n 此接口为系统接口。
**系统API**: 该接口为系统接口,三方应用不支持调用。 **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -305,7 +305,7 @@ isSuggested(language: string, region?: string): boolean ...@@ -305,7 +305,7 @@ isSuggested(language: string, region?: string): boolean
| boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 | | boolean | 返回true,表示当前语言和地区匹配;返回false,表示当前语言和地区不匹配。 |
**示例:** **示例:**
``` ```js
i18n.isSuggested('zh', 'CN'); i18n.isSuggested('zh', 'CN');
``` ```
...@@ -330,7 +330,7 @@ getCalendar(locale: string, type? : string): Calendar ...@@ -330,7 +330,7 @@ getCalendar(locale: string, type? : string): Calendar
| [Calendar](#calendar8) | 日历对象。 | | [Calendar](#calendar8) | 日历对象。 |
**示例:** **示例:**
``` ```js
i18n.getCalendar("zh-Hans", "gregory"); i18n.getCalendar("zh-Hans", "gregory");
``` ```
...@@ -352,7 +352,7 @@ setTime(date: Date): void ...@@ -352,7 +352,7 @@ setTime(date: Date): void
| date | Date | 是 | 将要设置的日历对象的内部时间日期。 | | date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("en-US", "gregory"); var calendar = i18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0); var date = new Date(2021, 10, 7, 8, 0, 0, 0);
calendar.setTime(date); calendar.setTime(date);
...@@ -373,7 +373,7 @@ setTime(time: number): void ...@@ -373,7 +373,7 @@ setTime(time: number): void
| time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 | | time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("en-US", "gregory"); var calendar = i18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000); calendar.setTime(10540800000);
``` ```
...@@ -398,7 +398,7 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se ...@@ -398,7 +398,7 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se
| second | number | 否 | 设置的秒。 | | second | number | 否 | 设置的秒。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
``` ```
...@@ -418,7 +418,7 @@ setTimeZone(timezone: string): void ...@@ -418,7 +418,7 @@ setTimeZone(timezone: string): void
| timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 | | timezone | string | 是 | 设置的时区id,如“Asia/Shanghai”。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai"); calendar.setTimeZone("Asia/Shanghai");
``` ```
...@@ -438,7 +438,7 @@ getTimeZone(): string ...@@ -438,7 +438,7 @@ getTimeZone(): string
| string | 日历对象的时区id。 | | string | 日历对象的时区id。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai"); calendar.setTimeZone("Asia/Shanghai");
calendar.getTimeZone(); // Asia/Shanghai" calendar.getTimeZone(); // Asia/Shanghai"
...@@ -459,7 +459,7 @@ getFirstDayOfWeek(): number ...@@ -459,7 +459,7 @@ getFirstDayOfWeek(): number
| number | 获取一周的起始日,1代表周日,7代表周六。 | | number | 获取一周的起始日,1代表周日,7代表周六。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("en-US", "gregory"); var calendar = i18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek(); calendar.getFirstDayOfWeek();
``` ```
...@@ -479,7 +479,7 @@ setFirstDayOfWeek(value: number): void ...@@ -479,7 +479,7 @@ setFirstDayOfWeek(value: number): void
| value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 | | value | number | 否 | 设置一周的起始日,1代表周日,7代表周六。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0); calendar.setFirstDayOfWeek(0);
``` ```
...@@ -499,7 +499,7 @@ getMinimalDaysInFirstWeek(): number ...@@ -499,7 +499,7 @@ getMinimalDaysInFirstWeek(): number
| number | 一年中第一周的最小天数。 | | number | 一年中第一周的最小天数。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek(); calendar.getMinimalDaysInFirstWeek();
``` ```
...@@ -519,7 +519,7 @@ setMinimalDaysInFirstWeek(value: number): void ...@@ -519,7 +519,7 @@ setMinimalDaysInFirstWeek(value: number): void
| value | number | 否 | 一年中第一周的最小天数。 | | value | number | 否 | 一年中第一周的最小天数。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3); calendar.setMinimalDaysInFirstWeek(3);
``` ```
...@@ -544,7 +544,7 @@ get(field: string): number ...@@ -544,7 +544,7 @@ get(field: string): number
| number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 | | number | 与field相关联的值,如当前Calendar对象的内部日期的年份为1990,get("year")返回1990。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
calendar.get("hour_of_day"); // 8 calendar.get("hour_of_day"); // 8
...@@ -570,7 +570,7 @@ getDisplayName(locale: string): string ...@@ -570,7 +570,7 @@ getDisplayName(locale: string): string
| string | 日历在locale所指示的区域的名字。 | | string | 日历在locale所指示的区域的名字。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("en-US", "buddhist"); var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // 佛历 calendar.getDisplayName("zh"); // 佛历
``` ```
...@@ -595,7 +595,7 @@ isWeekend(date?: Date): boolean ...@@ -595,7 +595,7 @@ isWeekend(date?: Date): boolean
| boolean | 当所判断的日期为周末时,返回&nbsp;true,否则返回false。 | | boolean | 当所判断的日期为周末时,返回&nbsp;true,否则返回false。 |
**示例:** **示例:**
``` ```js
var calendar = i18n.getCalendar("zh-Hans"); var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00 calendar.set(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
calendar.isWeekend(); // false calendar.isWeekend(); // false
...@@ -622,7 +622,7 @@ constructor(country: string, options?: PhoneNumberFormatOptions) ...@@ -622,7 +622,7 @@ constructor(country: string, options?: PhoneNumberFormatOptions)
| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 | | options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 |
**示例:** **示例:**
``` ```js
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"}); var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
``` ```
...@@ -646,7 +646,7 @@ isValidNumber(number: string): boolean ...@@ -646,7 +646,7 @@ isValidNumber(number: string): boolean
| boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 | | boolean | 返回true表示电话号码的格式正确,返回false表示电话号码的格式错误。 |
**示例:** **示例:**
``` ```js
var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312"); phonenumberfmt.isValidNumber("15812312312");
``` ```
...@@ -671,7 +671,7 @@ format(number: string): string ...@@ -671,7 +671,7 @@ format(number: string): string
| string | 格式化后的电话号码。 | | string | 格式化后的电话号码。 |
**示例:** **示例:**
``` ```js
var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312"); phonenumberfmt.format("15812312312");
``` ```
...@@ -686,18 +686,18 @@ static getLocationName(number: string, locale: string): string ...@@ -686,18 +686,18 @@ static getLocationName(number: string, locale: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- | | ------ | ------ | ---- | ---- |
| number | string | 是 | 电话号码 | | number | string | 是 | 电话号码 |
| locale | string | 是 | 区域ID | | locale | string | 是 | 区域ID |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------- | | ------ | -------- |
| string | 电话号码归属地。 | | string | 电话号码归属地。 |
**示例:** **示例:**
``` ```js
var location = i18n.PhoneNumberFormat.getLocationName('15812312345', 'zh-CN'); var location = i18n.PhoneNumberFormat.getLocationName('15812312345', 'zh-CN');
``` ```
...@@ -706,7 +706,7 @@ static getLocationName(number: string, locale: string): string ...@@ -706,7 +706,7 @@ static getLocationName(number: string, locale: string): string
表示电话号码格式化对象可设置的属性。 表示电话号码格式化对象可设置的属性。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | ------ | ---- | ---- | ---------------------------------------- | | ---- | ------ | ---- | ---- | ---------------------------------------- |
...@@ -717,7 +717,7 @@ static getLocationName(number: string, locale: string): string ...@@ -717,7 +717,7 @@ static getLocationName(number: string, locale: string): string
度量衡单位信息。 度量衡单位信息。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- | | ------------- | ------ | ---- | ---- | ---------------------------------------- |
...@@ -751,7 +751,7 @@ static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: ...@@ -751,7 +751,7 @@ static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale:
| string | 按照toUnit的单位格式化后,得到的字符串。 | | string | 按照toUnit的单位格式化后,得到的字符串。 |
**示例:** **示例:**
``` ```js
i18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); i18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
``` ```
...@@ -765,17 +765,17 @@ static getDateOrder(locale: string): string ...@@ -765,17 +765,17 @@ static getDateOrder(locale: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------- | | ------ | ------ | ---- | ------------------------- |
| locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 | | locale | string | 是 | 格式化时使用的区域参数,如:zh-Hans-CN。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------ | ------------------- |
| string | 返回某一区域的日期的年、月、日排列顺序 | | string | 返回某一区域的日期的年、月、日排列顺序 |
**示例:** **示例:**
``` ```js
i18n.Util.getDateOrder("zh-CN"); i18n.Util.getDateOrder("zh-CN");
``` ```
...@@ -799,7 +799,7 @@ getInstance(locale?:string): IndexUtil ...@@ -799,7 +799,7 @@ getInstance(locale?:string): IndexUtil
| [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 | | [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 |
**示例:** **示例:**
``` ```js
var indexUtil= i18n.getInstance("zh-CN"); var indexUtil= i18n.getInstance("zh-CN");
``` ```
...@@ -821,7 +821,7 @@ getIndexList(): Array&lt;string&gt; ...@@ -821,7 +821,7 @@ getIndexList(): Array&lt;string&gt;
| Array&lt;string&gt; | 返回当前locale对应的索引列表。 | | Array&lt;string&gt; | 返回当前locale对应的索引列表。 |
**示例:** **示例:**
``` ```js
var indexUtil = i18n.getInstance("zh-CN"); var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList(); var indexList = indexUtil.getIndexList();
``` ```
...@@ -841,7 +841,7 @@ addLocale(locale: string): void ...@@ -841,7 +841,7 @@ addLocale(locale: string): void
| locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 | | locale | string | 是 | 包含区域设置信息的字符串,包括语言以及可选的脚本和区域。 |
**示例:** **示例:**
``` ```js
var indexUtil = i18n.getInstance("zh-CN"); var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US"); indexUtil.addLocale("en-US");
``` ```
...@@ -866,9 +866,9 @@ getIndex(text: string): string ...@@ -866,9 +866,9 @@ getIndex(text: string): string
| string | 输入文本对应的索引值。 | | string | 输入文本对应的索引值。 |
**示例:** **示例:**
``` ```js
var indexUtil= i18n.getInstance("zh-CN"); var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // 返回h indexUtil.getIndex("hi"); // 返回hi
``` ```
...@@ -894,7 +894,7 @@ static isDigit(char: string): boolean ...@@ -894,7 +894,7 @@ static isDigit(char: string): boolean
| boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 | | boolean | 返回true表示输入的字符是数字,返回false表示输入的字符不是数字。 |
**示例:** **示例:**
``` ```js
var isdigit = i18n.Character.isDigit("1"); // 返回true var isdigit = i18n.Character.isDigit("1"); // 返回true
``` ```
...@@ -918,7 +918,7 @@ static isSpaceChar(char: string): boolean ...@@ -918,7 +918,7 @@ static isSpaceChar(char: string): boolean
| boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 | | boolean | 返回true表示输入的字符是空格符,返回false表示输入的字符不是空格符。 |
**示例:** **示例:**
``` ```js
var isspacechar = i18n.Character.isSpaceChar("a"); // 返回false var isspacechar = i18n.Character.isSpaceChar("a"); // 返回false
``` ```
...@@ -942,7 +942,7 @@ static isWhitespace(char: string): boolean ...@@ -942,7 +942,7 @@ static isWhitespace(char: string): boolean
| boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 | | boolean | 返回true表示输入的字符是空白符,返回false表示输入的字符不是空白符。 |
**示例:** **示例:**
``` ```js
var iswhitespace = i18n.Character.isWhitespace("a"); // 返回false var iswhitespace = i18n.Character.isWhitespace("a"); // 返回false
``` ```
...@@ -966,7 +966,7 @@ static isRTL(char: string): boolean ...@@ -966,7 +966,7 @@ static isRTL(char: string): boolean
| boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 | | boolean | 返回true表示输入的字符是从右到左语言的字符,返回false表示输入的字符不是从右到左语言的字符。 |
**示例:** **示例:**
``` ```js
var isrtl = i18n.Character.isRTL("a"); // 返回false var isrtl = i18n.Character.isRTL("a"); // 返回false
``` ```
...@@ -990,7 +990,7 @@ static isIdeograph(char: string): boolean ...@@ -990,7 +990,7 @@ static isIdeograph(char: string): boolean
| boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 | | boolean | 返回true表示输入的字符是表意文字,返回false表示输入的字符不是表意文字。 |
**示例:** **示例:**
``` ```js
var isideograph = i18n.Character.isIdeograph("a"); // 返回false var isideograph = i18n.Character.isIdeograph("a"); // 返回false
``` ```
...@@ -1014,7 +1014,7 @@ static isLetter(char: string): boolean ...@@ -1014,7 +1014,7 @@ static isLetter(char: string): boolean
| boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 | | boolean | 返回true表示输入的字符是字母,返回false表示输入的字符不是字母。 |
**示例:** **示例:**
``` ```js
var isletter = i18n.Character.isLetter("a"); // 返回true var isletter = i18n.Character.isLetter("a"); // 返回true
``` ```
...@@ -1038,7 +1038,7 @@ static isLowerCase(char: string): boolean ...@@ -1038,7 +1038,7 @@ static isLowerCase(char: string): boolean
| boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 | | boolean | 返回true表示输入的字符是小写字母,返回false表示输入的字符不是小写字母。 |
**示例:** **示例:**
``` ```js
var islowercase = i18n.Character.isLowerCase("a"); // 返回true var islowercase = i18n.Character.isLowerCase("a"); // 返回true
``` ```
...@@ -1062,7 +1062,7 @@ static isUpperCase(char: string): boolean ...@@ -1062,7 +1062,7 @@ static isUpperCase(char: string): boolean
| boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 | | boolean | 返回true表示输入的字符是大写字母,返回false表示输入的字符不是大写字母。 |
**示例:** **示例:**
``` ```js
var isuppercase = i18n.Character.isUpperCase("a"); // 返回false var isuppercase = i18n.Character.isUpperCase("a"); // 返回false
``` ```
...@@ -1086,7 +1086,7 @@ static getType(char: string): string ...@@ -1086,7 +1086,7 @@ static getType(char: string): string
| string | 输入字符的一般类别值。 | | string | 输入字符的一般类别值。 |
**示例:** **示例:**
``` ```js
var type = i18n.Character.getType("a"); var type = i18n.Character.getType("a");
``` ```
...@@ -1110,7 +1110,7 @@ getLineInstance(locale: string): BreakIterator ...@@ -1110,7 +1110,7 @@ getLineInstance(locale: string): BreakIterator
| [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 | | [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
``` ```
...@@ -1132,7 +1132,7 @@ setLineBreakText(text: string): void ...@@ -1132,7 +1132,7 @@ setLineBreakText(text: string): void
| text | string | 是 | 指定BreakIterator进行断句的文本。 | | text | string | 是 | 指定BreakIterator进行断句的文本。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
``` ```
...@@ -1152,7 +1152,7 @@ getLineBreakText(): string ...@@ -1152,7 +1152,7 @@ getLineBreakText(): string
| string | BreakIterator对象正在处理的文本 | | string | BreakIterator对象正在处理的文本 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.getLineBreakText(); // Apple is my favorite fruit. iterator.getLineBreakText(); // Apple is my favorite fruit.
...@@ -1173,7 +1173,7 @@ current(): number ...@@ -1173,7 +1173,7 @@ current(): number
| number | BreakIterator在当前所处理的文本中的位置。 | | number | BreakIterator在当前所处理的文本中的位置。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.current(); // 0 iterator.current(); // 0
...@@ -1194,7 +1194,7 @@ first(): number ...@@ -1194,7 +1194,7 @@ first(): number
| number | 被处理文本的第一个分割点的偏移量。 | | number | 被处理文本的第一个分割点的偏移量。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0 iterator.first(); // 0
...@@ -1215,7 +1215,7 @@ last(): number ...@@ -1215,7 +1215,7 @@ last(): number
| number | 被处理的文本的最后一个分割点的偏移量 | | number | 被处理的文本的最后一个分割点的偏移量 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.last(); // 27 iterator.last(); // 27
...@@ -1241,7 +1241,7 @@ next(index?: number): number ...@@ -1241,7 +1241,7 @@ next(index?: number): number
| number | 返回移动了index个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 | | number | 返回移动了index个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0 iterator.first(); // 0
...@@ -1264,7 +1264,7 @@ previous(): number ...@@ -1264,7 +1264,7 @@ previous(): number
| number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 | | number | 返回移动到前一个分割点后,当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围,返回-1。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0 iterator.first(); // 0
...@@ -1292,7 +1292,7 @@ following(offset: number): number ...@@ -1292,7 +1292,7 @@ following(offset: number): number
| number | 返回[BreakIterator](#breakiterator8)移动后的位置,如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 | | number | 返回[BreakIterator](#breakiterator8)移动后的位置,如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.following(0); // 6 iterator.following(0); // 6
...@@ -1320,7 +1320,7 @@ isBoundary(offset: number): boolean ...@@ -1320,7 +1320,7 @@ isBoundary(offset: number): boolean
| boolean | 如果是一个分割点返回true,&nbsp;否则返回false。 | | boolean | 如果是一个分割点返回true,&nbsp;否则返回false。 |
**示例:** **示例:**
``` ```js
var iterator = i18n.getLineInstance("en"); var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit."); iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.isBoundary(0); // true; iterator.isBoundary(0); // true;
...@@ -1342,7 +1342,7 @@ is24HourClock(): boolean ...@@ -1342,7 +1342,7 @@ is24HourClock(): boolean
| boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 | | boolean | 返回true,表示系统24小时开关开启;返回false,表示系统24小时开关关闭。 |
**示例:** **示例:**
``` ```js
var is24HourClock = i18n.is24HourClock(); var is24HourClock = i18n.is24HourClock();
``` ```
...@@ -1368,7 +1368,7 @@ set24HourClock(option: boolean): boolean ...@@ -1368,7 +1368,7 @@ set24HourClock(option: boolean): boolean
| boolean | 返回true,表示修改成功;返回false,表示修改失败。 | | boolean | 返回true,表示修改成功;返回false,表示修改失败。 |
**示例:** **示例:**
``` ```js
// 将系统时间设置为24小时制 // 将系统时间设置为24小时制
var success = i18n.set24HourClock(true); var success = i18n.set24HourClock(true);
``` ```
...@@ -1396,7 +1396,7 @@ addPreferredLanguage(language: string, index?: number): boolean ...@@ -1396,7 +1396,7 @@ addPreferredLanguage(language: string, index?: number): boolean
| boolean | 返回true,表示添加成功;返回false,表示添加失败。 | | boolean | 返回true,表示添加成功;返回false,表示添加失败。 |
**示例:** **示例:**
``` ```js
// 将语言zh-CN添加到系统偏好语言列表中 // 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN'; var language = 'zh-CN';
var index = 0; var index = 0;
...@@ -1425,7 +1425,7 @@ removePreferredLanguage(index: number): boolean ...@@ -1425,7 +1425,7 @@ removePreferredLanguage(index: number): boolean
| boolean | 返回true,表示删除成功;返回false,表示删除失败。 | | boolean | 返回true,表示删除成功;返回false,表示删除失败。 |
**示例:** **示例:**
``` ```js
// 删除系统偏好语言列表中的第一个偏好语言 // 删除系统偏好语言列表中的第一个偏好语言
var index = 0; var index = 0;
var success = i18n.removePreferredLanguage(index); var success = i18n.removePreferredLanguage(index);
...@@ -1446,7 +1446,7 @@ getPreferredLanguageList(): Array&lt;string&gt; ...@@ -1446,7 +1446,7 @@ getPreferredLanguageList(): Array&lt;string&gt;
| Array&lt;string&gt; | 系统偏好语言列表。 | | Array&lt;string&gt; | 系统偏好语言列表。 |
**示例:** **示例:**
``` ```js
var preferredLanguageList = i18n.getPreferredLanguageList(); var preferredLanguageList = i18n.getPreferredLanguageList();
``` ```
...@@ -1465,7 +1465,7 @@ getFirstPreferredLanguage(): string ...@@ -1465,7 +1465,7 @@ getFirstPreferredLanguage(): string
| string | 偏好语言列表中的第一个语言。 | | string | 偏好语言列表中的第一个语言。 |
**示例:** **示例:**
``` ```js
var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
``` ```
...@@ -1479,12 +1479,12 @@ getAppPreferredLanguage(): string ...@@ -1479,12 +1479,12 @@ getAppPreferredLanguage(): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------------- | | ------ | -------- |
| string | 应用的偏好语言。 | | string | 应用的偏好语言。 |
**示例:** **示例:**
``` ```js
var appPreferredLanguage = i18n.getAppPreferredLanguage(); var appPreferredLanguage = i18n.getAppPreferredLanguage();
``` ```
...@@ -1508,7 +1508,7 @@ getTimeZone(zoneID?: string): TimeZone ...@@ -1508,7 +1508,7 @@ getTimeZone(zoneID?: string): TimeZone
| TimeZone | 时区ID对应的时区对象。 | | TimeZone | 时区ID对应的时区对象。 |
**示例:** **示例:**
``` ```js
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
``` ```
...@@ -1530,7 +1530,7 @@ getID(): string ...@@ -1530,7 +1530,7 @@ getID(): string
| string | 时区对象对应的时区ID。 | | string | 时区对象对应的时区ID。 |
**示例:** **示例:**
``` ```js
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getID(); timezone.getID();
``` ```
...@@ -1556,7 +1556,7 @@ getDisplayName(locale?: string, isDST?: boolean): string ...@@ -1556,7 +1556,7 @@ getDisplayName(locale?: string, isDST?: boolean): string
| string | 时区对象在指定区域的表示。 | | string | 时区对象在指定区域的表示。 |
**示例:** **示例:**
``` ```js
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false); timezone.getDisplayName("zh-CN", false);
``` ```
...@@ -1576,7 +1576,7 @@ getRawOffset(): number ...@@ -1576,7 +1576,7 @@ getRawOffset(): number
| number | 时区对象表示的时区与UTC时区的偏差。 | | number | 时区对象表示的时区与UTC时区的偏差。 |
**示例:** **示例:**
``` ```js
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getRawOffset(); timezone.getRawOffset();
``` ```
...@@ -1596,7 +1596,7 @@ getOffset(date?: number): number ...@@ -1596,7 +1596,7 @@ getOffset(date?: number): number
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 | | number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
**示例:** **示例:**
``` ```js
var timezone = i18n.getTimeZone(); var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890); timezone.getOffset(1234567890);
``` ```
...@@ -1611,12 +1611,12 @@ static getAvailableIDs(): Array&lt;string&gt; ...@@ -1611,12 +1611,12 @@ static getAvailableIDs(): Array&lt;string&gt;
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------------------- | ----------- |
| Array&lt;string&gt; | 系统支持的时区ID列表 | | Array&lt;string&gt; | 系统支持的时区ID列表 |
**示例:** **示例:**
``` ```ts
var ids = i18n.TimeZone.getAvailableIDs(); var ids = i18n.TimeZone.getAvailableIDs();
``` ```
...@@ -1630,12 +1630,12 @@ static getAvailableZoneCityIDs(): Array&lt;string&gt; ...@@ -1630,12 +1630,12 @@ static getAvailableZoneCityIDs(): Array&lt;string&gt;
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------------------- | ------------- |
| Array&lt;string&gt; | 系统支持的时区城市ID列表 | | Array&lt;string&gt; | 系统支持的时区城市ID列表 |
**示例:** **示例:**
``` ```ts
var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs(); var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs();
``` ```
...@@ -1649,18 +1649,18 @@ static getCityDisplayName(cityID: string, locale: string): string ...@@ -1649,18 +1649,18 @@ static getCityDisplayName(cityID: string, locale: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- | | ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID | | cityID | string | 是 | 时区城市ID |
| locale | string | 是 | 区域ID | | locale | string | 是 | 区域ID |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | ------ | ------------------ |
| string | 时区城市在locale下的本地化显示 | | string | 时区城市在locale下的本地化显示 |
**示例:** **示例:**
``` ```ts
var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN"); var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN");
``` ```
...@@ -1674,17 +1674,17 @@ static getTimezoneFromCity(cityID: string): TimeZone ...@@ -1674,17 +1674,17 @@ static getTimezoneFromCity(cityID: string): TimeZone
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- | | ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID | | cityID | string | 是 | 时区城市ID |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------------------- | | -------- | ----------- |
| TimeZone | 时区城市对应的时区对象 | | TimeZone | 时区城市对应的时区对象 |
**示例:** **示例:**
``` ```ts
var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai"); var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai");
``` ```
...@@ -1695,24 +1695,24 @@ setUsingLocalDigit(flag: boolean): boolean ...@@ -1695,24 +1695,24 @@ setUsingLocalDigit(flag: boolean): boolean
设置是否打开本地数字开关。 设置是否打开本地数字开关。
接口为系统接口。 接口为系统接口。
**需要权限**:ohos.permission.UPDATE_CONFIGURATION **需要权限**:ohos.permission.UPDATE_CONFIGURATION
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- | | ---- | ------- | ---- | ------------------------------- |
| flag | boolean | 是 | true表示打开本地数字开关,false表示关闭本地数字开关。 | | flag | boolean | 是 | true表示打开本地数字开关,false表示关闭本地数字开关。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------ | | ------- | ----------------------------------- |
| boolean | true表示本地数字开关设置成功,false表示本地数字开关设置失败。 | | boolean | true表示本地数字开关设置成功,false表示本地数字开关设置失败。 |
**示例:** **示例:**
``` ```ts
var status = i18n.setUsingLocalDigit(true); var status = i18n.setUsingLocalDigit(true);
``` ```
...@@ -1726,12 +1726,12 @@ getUsingLocalDigit(): boolean ...@@ -1726,12 +1726,12 @@ getUsingLocalDigit(): boolean
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | ------------ | | ------- | ---------------------------------------- |
| boolean | true表示系统当前已打开本地数字开关,false表示系统当前未打开本地数字开关。 | | boolean | true表示系统当前已打开本地数字开关,false表示系统当前未打开本地数字开关。 |
**示例:** **示例:**
``` ```ts
var status = i18n.getUsingLocalDigit(); var status = i18n.getUsingLocalDigit();
``` ```
...@@ -1748,12 +1748,12 @@ static getAvailableIDs(): string[] ...@@ -1748,12 +1748,12 @@ static getAvailableIDs(): string[]
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------ | | -------- | ---------- |
| string[] | 音译支持的ID列表。 | | string[] | 音译支持的ID列表。 |
**示例:** **示例:**
``` ```ts
i18n.Transliterator.getAvailableIDs(); i18n.Transliterator.getAvailableIDs();
``` ```
...@@ -1767,17 +1767,17 @@ static getInstance(id: string): Transliterator ...@@ -1767,17 +1767,17 @@ static getInstance(id: string): Transliterator
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- | | ---- | ------ | ---- | -------- |
| id | string | 是 | 音译支持的ID。 | | id | string | 是 | 音译支持的ID。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ---------------------------------- | ----- |
| [Transliterator](#transliterator9) | 音译对象。 | | [Transliterator](#transliterator9) | 音译对象。 |
**示例:** **示例:**
``` ```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn"); var transliterator = i18n.Transliterator.getInstance("Any-Latn");
``` ```
...@@ -1791,17 +1791,17 @@ transform(text: string): string ...@@ -1791,17 +1791,17 @@ transform(text: string): string
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- | | ---- | ------ | ---- | ------ |
| text | string | 是 | 输入字符串。 | | text | string | 是 | 输入字符串。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ------------- | | ------ | -------- |
| string | 转换后的字符串。 | | string | 转换后的字符串。 |
**示例:** **示例:**
``` ```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn"); var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transliterator.transform("中国"); transliterator.transform("中国");
``` ```
\ No newline at end of file
...@@ -6,13 +6,13 @@ InputConsumer模块提供对按键事件的监听。 ...@@ -6,13 +6,13 @@ InputConsumer模块提供对按键事件的监听。
> >
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> - 本模块接口均为系统接口,三方应用不支持调用 > - 本模块接口为系统接口
## 导入模块 ## 导入模块
``` ```js
import inputConsumer from '@ohos.multimodalInput.inputConsumer'; import inputConsumer from '@ohos.multimodalInput.inputConsumer';
``` ```
...@@ -23,21 +23,19 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): v ...@@ -23,21 +23,19 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): v
开始监听组合按键事件, 当满足条件的组合按键输入事件发生时,将keyOptions回调到入参callback表示的回调函数上。 开始监听组合按键事件, 当满足条件的组合按键输入事件发生时,将keyOptions回调到入参callback表示的回调函数上。
此接口为系统接口。
**系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer **系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | -------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 监听输入事件类型,只支持“key”。 | | type | string | 是 | 监听输入事件类型,只支持“key”。 |
| keyOptions | [keyOptions](#keyoptions) | 是 | 组合键选项,用来指定组合键输入时应该符合的条件。 | | keyOptions | [keyOptions](#keyoptions) | 是 | 组合键选项,用来指定组合键输入时应该符合的条件。 |
| callback | Callback&lt;KeyOptions&gt; | 是 | 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的KeyOptions为入参。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 回调函数。当满足条件的按键输入产生时,回调到此函数,以传入的KeyOptions为入参。 |
**示例:** **示例:**
``` ```js
let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) { let callback = function(keyOptions) {
console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey, console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
...@@ -53,21 +51,19 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback&lt;KeyOptions&gt;): ...@@ -53,21 +51,19 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback&lt;KeyOptions&gt;):
停止监听组合按键事件。 停止监听组合按键事件。
此接口为系统接口。
**系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer **系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | ---------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型,只支持“key”。 | | type | string | 是 | 监听输入事件类型,只支持“key”。 |
| keyOptions | [keyOptions](#keyoptions) | 是 | 开始监听时传入的keyOptions。 | | keyOptions | [keyOptions](#keyoptions) | 是 | 开始监听时传入的keyOptions。 |
| callback | Callback&lt;KeyOptions&gt; | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 | | callback | Callback&lt;KeyOptions&gt; | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 |
**示例:** **示例:**
``` ```js
let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0} let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) { let callback = function(keyOptions) {
console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey, console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
...@@ -81,13 +77,11 @@ inputConsumer.off('key', keyOptions, callback); ...@@ -81,13 +77,11 @@ inputConsumer.off('key', keyOptions, callback);
组合键输入事件发生时,组合键满足的选项。 组合键输入事件发生时,组合键满足的选项。
此接口为系统接口。
**系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer **系统能力:** SystemCapability.MultimodalInput.Input.InputConsumer
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------------------- | ------- | ---- | ------------------------ |
| preKeys | Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 | | preKeys | Array | 是 | 组合键前置按键集合,可为空,前置按键无顺序要求。 |
| finalKey | Number | 是 | 组合键最后按键,不能为空。 | | finalKey | Number | 是 | 组合键最后按键,不能为空。 |
| isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 | | isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起,默认是按下。 |
| finalKeyDownDuration | Number | 是 | 组合键最后按键按下持续时长,默认无时长要求。 | | finalKeyDownDuration | Number | 是 | 组合键最后按键按下持续时长,默认无时长要求。 |
...@@ -284,7 +284,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -284,7 +284,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的描述信息。 输入设备的描述信息。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------- | --------------------------- | --------------------------------- | | -------- | --------------------------- | --------------------------------- |
...@@ -295,7 +295,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -295,7 +295,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的描述信息。 输入设备的描述信息。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------------------- | -------------------------------------- | ---------------------------------------- | | -------------------- | -------------------------------------- | ---------------------------------------- |
...@@ -314,7 +314,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -314,7 +314,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴类型。 输入设备的轴类型。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ----------- | ------ | --------------- | | ----------- | ------ | --------------- |
...@@ -332,12 +332,12 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -332,12 +332,12 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴信息。 输入设备的轴信息。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**: SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ----------------------- | ------------------------- | -------- | | ----------------------- | ------------------------- | -------- |
| source | [SourceType](#sourcetype) | 轴的输入源类型。 | | source | [SourceType](#sourcetype) | 轴的输入源类型。 |
| axis | [AxisType](#axistype9) | 轴的类型。 | | axis | [AxisType](#axistype9) | 轴的类型。 |
| max | number | 轴的最大值。 | | max | number | 轴的最大值。 |
| min | number | 轴的最小值。 | | min | number | 轴的最小值。 |
| fuzz<sup>9+</sup> | number | 轴的模糊值。 | | fuzz<sup>9+</sup> | number | 轴的模糊值。 |
...@@ -348,7 +348,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -348,7 +348,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义这个轴的输入源类型。比如鼠标设备可上报x轴事件,则x轴的源就是鼠标。 定义这个轴的输入源类型。比如鼠标设备可上报x轴事件,则x轴的源就是鼠标。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ----------- | ------ | ----------- | | ----------- | ------ | ----------- |
...@@ -363,7 +363,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -363,7 +363,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义监听设备热插拔事件。 定义监听设备热插拔事件。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| ------ | ------ | --------- | | ------ | ------ | --------- |
...@@ -374,7 +374,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{ ...@@ -374,7 +374,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义键盘输入设备的类型。 定义键盘输入设备的类型。
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice **系统能力**:SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 值 | 说明 | | 名称 | 参数类型 | 值 | 说明 |
| ------------------- | ------ | ---- | --------- | | ------------------- | ------ | ---- | --------- |
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
InputEvent模块描述了设备上报的基本事件。 InputEvent模块描述了设备上报的基本事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -13,12 +13,12 @@ import InputEvent from '@ohos.multimodalInput.inputEvent'; ...@@ -13,12 +13,12 @@ import InputEvent from '@ohos.multimodalInput.inputEvent';
## InputEvent ## InputEvent
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ---------- | ------ | ---- | ---- | -------------- |
| id | number | 是 | 否 | 由服务端生成全局唯一事件id | | id | number | 是 | 否 | 由服务端生成全局唯一事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id | | deviceId | number | 是 | 否 | 上报输入事件的设备id |
| actionTime | number | 是 | 否 | 输入事件的上报时间 | | actionTime | number | 是 | 否 | 输入事件的上报时间 |
| screenId | number | 是 | 否 | 目标屏幕id | | screenId | number | 是 | 否 | 目标屏幕id |
| windowId | number | 是 | 否 | 目标窗口id | | windowId | number | 是 | 否 | 目标窗口id |
\ No newline at end of file \ No newline at end of file
...@@ -6,7 +6,7 @@ InputEventClient模块提供了注入按键能力。 ...@@ -6,7 +6,7 @@ InputEventClient模块提供了注入按键能力。
> >
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> - 本模块接口均为系统接口,三方应用不支持调用 > - 本模块接口为系统接口
## 导入模块 ## 导入模块
...@@ -23,8 +23,6 @@ injectEvent({KeyEvent: KeyEvent}): void ...@@ -23,8 +23,6 @@ injectEvent({KeyEvent: KeyEvent}): void
注入按键,KeyEvent为注入按键的描述信息。 注入按键,KeyEvent为注入按键的描述信息。
此接口为系统接口。
**系统能力:** SystemCapability.MultimodalInput.Input.InputSimulator **系统能力:** SystemCapability.MultimodalInput.Input.InputSimulator
**参数:** **参数:**
...@@ -48,15 +46,13 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent}); ...@@ -48,15 +46,13 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent});
## KeyEvent ## KeyEvent
注入按键的描述信息 注入按键的描述信息。
此接口为系统接口。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator **系统能力:** SystemCapability.MultimodalInput.Input.InputSimulator
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| --------------- | ------- | ---- | --------- | | --------------- | ------- | ---- | --------- |
| isPressed | boolean | 是 | 按键是否按下 | | isPressed | boolean | 是 | 按键是否按下 |
| keyCode | number | 是 | 按键键值 | | keyCode | number | 是 | 按键键值 |
| keyDownDuration | number | 是 | 按键按下持续时间 | | keyDownDuration | number | 是 | 按键按下持续时间 |
| isIntercepted | boolean | 是 | 按键是否可以被拦截 | | isIntercepted | boolean | 是 | 按键是否可以被拦截 |
...@@ -2,10 +2,10 @@ ...@@ -2,10 +2,10 @@
InputMonitor模块提供了监听全局触摸事件的功能。 InputMonitor模块提供了监听全局触摸事件的功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> - 本模块接口均为系统接口,三方应用不支持调用 > - 本模块接口均为系统接口。
## 导入模块 ## 导入模块
...@@ -16,28 +16,21 @@ import inputMonitor from '@ohos.multimodalInput.inputMonitor'; ...@@ -16,28 +16,21 @@ import inputMonitor from '@ohos.multimodalInput.inputMonitor';
``` ```
## 权限
ohos.permission.INPUT_MONITORING
## inputMonitor.on ## inputMonitor.on
on(type: "touch", receiver: TouchEventReceiver): void on(type: "touch", receiver: TouchEventReceiver): void
开始监听全局触屏事件。 开始监听全局触屏事件。
此接口为系统接口。
**需要权限:** ohos.permission.INPUT_MONITORING **需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型,取值“touch”。 | | type | string | 是 | 监听输入事件类型,取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 |
**示例:** **示例:**
...@@ -53,18 +46,16 @@ on(type: "mouse", receiver: Callback&lt;MouseEvent&gt;): void ...@@ -53,18 +46,16 @@ on(type: "mouse", receiver: Callback&lt;MouseEvent&gt;): void
开始监听全局鼠标事件。 开始监听全局鼠标事件。
此接口为系统接口。
**需要权限:** ohos.permission.INPUT_MONITORING **需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------- | | -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型,取值“mouse”。 | | type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback&lt;MouseEvent&gt; | 是 | 鼠标输入事件回调函数。 | | receiver | Callback&lt;MouseEvent&gt; | 是 | 鼠标输入事件回调函数。 |
**示例:** **示例:**
...@@ -82,17 +73,15 @@ off(type: "touch", receiver?: TouchEventReceiver): void ...@@ -82,17 +73,15 @@ off(type: "touch", receiver?: TouchEventReceiver): void
停止监听全局触屏事件。 停止监听全局触屏事件。
此接口为系统接口。
**需要权限:** ohos.permission.INPUT_MONITORING **需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------- | | -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型,取值“touch”。 | | type | string | 是 | 监听输入事件类型,取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 | | receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 |
**示例:** **示例:**
...@@ -104,18 +93,16 @@ off(type: "mouse", receiver?: Callback&lt;MouseEvent&gt;): void ...@@ -104,18 +93,16 @@ off(type: "mouse", receiver?: Callback&lt;MouseEvent&gt;): void
停止监听全局鼠标事件。 停止监听全局鼠标事件。
此接口为系统接口。
**需要权限:** ohos.permission.INPUT_MONITORING **需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
**参数:** **参数:**
| 参数 | 类型 | 必填 | 说明 | | 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------- | | -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型,取值“mouse”。 | | type | string | 是 | 监听输入事件类型,取值“mouse”。 |
| receiver | Callback&lt;MouseEvent&gt; | 否 | 鼠标输入事件回调函数。 | | receiver | Callback&lt;MouseEvent&gt; | 否 | 鼠标输入事件回调函数。 |
**示例:** **示例:**
...@@ -129,7 +116,7 @@ inputMonitor.off("mouse"); ...@@ -129,7 +116,7 @@ inputMonitor.off("mouse");
触摸输入事件的回调函数。如果返回true,则触摸输入被监听器消耗,系统将执行关闭动作。 触摸输入事件的回调函数。如果返回true,则触摸输入被监听器消耗,系统将执行关闭动作。
此接口为系统接口。 **需要权限:** ohos.permission.INPUT_MONITORING
**系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor **系统能力:** SystemCapability.MultimodalInput.Input.InputMonitor
...@@ -139,8 +126,8 @@ inputMonitor.off("mouse"); ...@@ -139,8 +126,8 @@ inputMonitor.off("mouse");
| touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件回调函数,返回true表示输触事件被监听器消费,false表示输触事件未被监听器消费。 | | touchEvent | [TouchEvent](../arkui-js/js-components-common-events.md) | 是 | 触摸输入事件回调函数,返回true表示输触事件被监听器消费,false表示输触事件未被监听器消费。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | -------------------------------------- | | ------- | ---------------------------------------- |
| Boolean | 返回true表示触摸输入事件被监听器消费,false表示触摸输入事件未被监听器消费。 | | Boolean | 返回true表示触摸输入事件被监听器消费,false表示触摸输入事件未被监听器消费。 |
**示例:** **示例:**
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
本模块提供提供基础的应用国际化能力,包括时间日期格式化、数字格式化、排序等,相关接口在ECMA 402标准中定义。 本模块提供提供基础的应用国际化能力,包括时间日期格式化、数字格式化、排序等,相关接口在ECMA 402标准中定义。
[I18N模块](js-apis-i18n.md)提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。 [I18N模块](js-apis-i18n.md)提供其他非ECMA 402定义的国际化接口,与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> >
> - Intl模块包含国际化能力基础接口(在ECMA 402中定义),包括时间日期格式化、数字格式化、排序等,国际化增强能力请参考[I18N模块](js-apis-i18n.md)。 > - Intl模块包含国际化能力基础接口(在ECMA 402中定义),包括时间日期格式化、数字格式化、排序等,国际化增强能力请参考[I18N模块](js-apis-i18n.md)。
...@@ -11,7 +11,7 @@ ...@@ -11,7 +11,7 @@
## 导入模块 ## 导入模块
``` ```js
import Intl from '@ohos.intl'; import Intl from '@ohos.intl';
``` ```
...@@ -46,7 +46,7 @@ constructor() ...@@ -46,7 +46,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var locale = new Intl.Locale(); var locale = new Intl.Locale();
``` ```
...@@ -66,7 +66,7 @@ constructor(locale: string, options?: LocaleOptions) ...@@ -66,7 +66,7 @@ constructor(locale: string, options?: LocaleOptions)
| options | LocaleOptions | 否 | 用于创建区域对象的选项。 | | options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
**示例:** **示例:**
``` ```js
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
``` ```
...@@ -85,7 +85,7 @@ toString(): string ...@@ -85,7 +85,7 @@ toString(): string
| string | 字符串形式的区域信息。 | | string | 字符串形式的区域信息。 |
**示例:** **示例:**
``` ```js
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.toString(); locale.toString();
``` ```
...@@ -105,7 +105,7 @@ maximize(): Locale ...@@ -105,7 +105,7 @@ maximize(): Locale
| [Locale](#locale) | 最大化后的区域对象。 | | [Locale](#locale) | 最大化后的区域对象。 |
**示例:** **示例:**
``` ```js
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.maximize(); locale.maximize();
``` ```
...@@ -125,7 +125,7 @@ minimize(): Locale ...@@ -125,7 +125,7 @@ minimize(): Locale
| [Locale](#locale) | 最小化后的区域对象。 | | [Locale](#locale) | 最小化后的区域对象。 |
**示例:** **示例:**
``` ```js
var locale = new Intl.Locale("zh-CN"); var locale = new Intl.Locale("zh-CN");
locale.minimize(); locale.minimize();
``` ```
...@@ -135,7 +135,7 @@ minimize(): Locale ...@@ -135,7 +135,7 @@ minimize(): Locale
表示区域初始化选项。 表示区域初始化选项。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- | | --------------- | ------- | ---- | ---- | ---------------------------------------- |
...@@ -159,7 +159,7 @@ constructor() ...@@ -159,7 +159,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var datefmt= new Intl.DateTimeFormat(); var datefmt= new Intl.DateTimeFormat();
``` ```
...@@ -179,13 +179,13 @@ constructor(locale: string | Array&lt;string&gt;, options?: DateTimeOptions) ...@@ -179,13 +179,13 @@ constructor(locale: string | Array&lt;string&gt;, options?: DateTimeOptions)
| options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 | | options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
**示例:** **示例:**
``` ```js
var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' }); var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
``` ```
**示例:** **示例:**
``` ```js
var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' }); var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
``` ```
...@@ -209,7 +209,7 @@ format(date: Date): string ...@@ -209,7 +209,7 @@ format(date: Date): string
| string | 格式化后的时间日期字符串 | | string | 格式化后的时间日期字符串 |
**示例:** **示例:**
``` ```js
var date = new Date(2021, 11, 17, 3, 24, 0); var date = new Date(2021, 11, 17, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB"); var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.format(date); datefmt.format(date);
...@@ -236,7 +236,7 @@ formatRange(startDate: Date, endDate: Date): string ...@@ -236,7 +236,7 @@ formatRange(startDate: Date, endDate: Date): string
| string | 格式化后的时间日期段字符串。 | | string | 格式化后的时间日期段字符串。 |
**示例:** **示例:**
``` ```js
var startDate = new Date(2021, 11, 17, 3, 24, 0); var startDate = new Date(2021, 11, 17, 3, 24, 0);
var endDate = new Date(2021, 11, 18, 3, 24, 0); var endDate = new Date(2021, 11, 18, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB"); var datefmt = new Intl.DateTimeFormat("en-GB");
...@@ -258,7 +258,7 @@ resolvedOptions(): DateTimeOptions ...@@ -258,7 +258,7 @@ resolvedOptions(): DateTimeOptions
| [DateTimeOptions](#datetimeoptions) | DateTimeFormat&nbsp;对象的格式化选项。 | | [DateTimeOptions](#datetimeoptions) | DateTimeFormat&nbsp;对象的格式化选项。 |
**示例:** **示例:**
``` ```js
var datefmt = new Intl.DateTimeFormat("en-GB"); var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.resolvedOptions(); datefmt.resolvedOptions();
``` ```
...@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions ...@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions
表示时间日期格式化选项。 表示时间日期格式化选项。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- | | --------------- | ------- | ---- | ---- | ---------------------------------------- |
...@@ -305,7 +305,7 @@ constructor() ...@@ -305,7 +305,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var numfmt = new Intl.NumberFormat(); var numfmt = new Intl.NumberFormat();
``` ```
...@@ -325,7 +325,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: NumberOptions) ...@@ -325,7 +325,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: NumberOptions)
| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 | | options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
**示例:** **示例:**
``` ```js
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
``` ```
...@@ -350,7 +350,7 @@ format(number: number): string; ...@@ -350,7 +350,7 @@ format(number: number): string;
**示例:** **示例:**
``` ```js
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223); numfmt.format(1223);
``` ```
...@@ -371,7 +371,7 @@ resolvedOptions(): NumberOptions ...@@ -371,7 +371,7 @@ resolvedOptions(): NumberOptions
**示例:** **示例:**
``` ```js
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"}); var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions(); numfmt.resolvedOptions();
``` ```
...@@ -391,7 +391,7 @@ resolvedOptions(): NumberOptions ...@@ -391,7 +391,7 @@ resolvedOptions(): NumberOptions
| currencyDisplay | string | 是 | 是 | 货币的显示方式,取值包括:"symbol",&nbsp;"narrowSymbol",&nbsp;"code",&nbsp;"name"。 | | currencyDisplay | string | 是 | 是 | 货币的显示方式,取值包括:"symbol",&nbsp;"narrowSymbol",&nbsp;"code",&nbsp;"name"。 |
| unit | string | 是 | 是 | 单位名称,如:"meter","inch",“hectare”等。 | | unit | string | 是 | 是 | 单位名称,如:"meter","inch",“hectare”等。 |
| unitDisplay | string | 是 | 是 | 单位的显示格式,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 | | unitDisplay | string | 是 | 是 | 单位的显示格式,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 |
| unitUsage<sup>8+</sup> | string | 是 | 是 | 单位的使用场景,取值包括:"default",&nbsp;"area-land-agricult",&nbsp;"area-land-commercl",&nbsp;"area-land-residntl",&nbsp;"length-person",&nbsp;"length-person-small",&nbsp;"length-rainfall",&nbsp;"length-road",&nbsp;"length-road-small",&nbsp;"length-snowfall",&nbsp;"length-vehicle",&nbsp;"length-visiblty",&nbsp;"length-visiblty-small",&nbsp;"length-person-informal",&nbsp;"length-person-small-informal",&nbsp;"length-road-informal",&nbsp;"speed-road-travel",&nbsp;"speed-wind",&nbsp;"temperature-person",&nbsp;"temperature-weather",&nbsp;"volume-vehicle-fuel"。 | | unitUsage<sup>8+</sup> | string | 是 | 是 | 单位的使用场景,取值包括:"default",&nbsp;"area-land-agricult",&nbsp;"area-land-commercl",&nbsp;"area-land-residntl",&nbsp;"length-person",&nbsp;"length-person-small",&nbsp;"length-rainfall",&nbsp;"length-road",&nbsp;"length-road-small",&nbsp;"length-snowfall",&nbsp;"length-vehicle",&nbsp;"length-visiblty",&nbsp;"length-visiblty-small",&nbsp;"length-person-informal",&nbsp;"length-person-small-informal",&nbsp;"length-road-informal",&nbsp;"speed-road-travel",&nbsp;"speed-wind",&nbsp;"temperature-person",&nbsp;"temperature-weather",&nbsp;"volume-vehicle-fuel"。 |
| signDisplay | string | 是 | 是 | 数字符号的显示格式,取值包括:"auto",&nbsp;"never",&nbsp;"always",&nbsp;"expectZero"。 | | signDisplay | string | 是 | 是 | 数字符号的显示格式,取值包括:"auto",&nbsp;"never",&nbsp;"always",&nbsp;"expectZero"。 |
| compactDisplay | string | 是 | 是 | 紧凑型的显示格式,取值包括:"long",&nbsp;"short"。 | | compactDisplay | string | 是 | 是 | 紧凑型的显示格式,取值包括:"long",&nbsp;"short"。 |
| notation | string | 是 | 是 | 数字的格式化规格,取值包括:"standard",&nbsp;"scientific",&nbsp;"engineering",&nbsp;"compact"。 | | notation | string | 是 | 是 | 数字的格式化规格,取值包括:"standard",&nbsp;"scientific",&nbsp;"engineering",&nbsp;"compact"。 |
...@@ -418,7 +418,7 @@ constructor() ...@@ -418,7 +418,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var collator = new Intl.Collator(); var collator = new Intl.Collator();
``` ```
...@@ -439,7 +439,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: CollatorOptions) ...@@ -439,7 +439,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: CollatorOptions)
| options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 | | options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 |
**示例:** **示例:**
``` ```js
var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"}); var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});
``` ```
...@@ -464,7 +464,7 @@ compare(first: string, second: string): number ...@@ -464,7 +464,7 @@ compare(first: string, second: string): number
| number | 比较结果。当number为负数,表示first排序在second之前;当number为0,表示first与second排序相同;当number为正数,表示first排序在second之后。 | | number | 比较结果。当number为负数,表示first排序在second之前;当number为0,表示first与second排序相同;当number为正数,表示first排序在second之后。 |
**示例:** **示例:**
``` ```js
var collator = new Intl.Collator("zh-Hans"); var collator = new Intl.Collator("zh-Hans");
collator.compare("first", "second"); collator.compare("first", "second");
``` ```
...@@ -484,17 +484,17 @@ resolvedOptions(): CollatorOptions ...@@ -484,17 +484,17 @@ resolvedOptions(): CollatorOptions
| [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 | | [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 |
**示例:** **示例:**
``` ```js
var collator = new Intl.Collator("zh-Hans"); var collator = new Intl.Collator("zh-Hans");
var options = collator.resolvedOptions(); var options = collator.resolvedOptions();
``` ```
## CollatorOptions<sup>8+</sup><a name=collatoroptions></a> ## CollatorOptions<sup>8+</sup>
表示Collator可设置的属性。 表示Collator可设置的属性。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- | | ----------------- | ------- | ---- | ---- | ---------------------------------------- |
...@@ -519,7 +519,7 @@ constructor() ...@@ -519,7 +519,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var pluralRules = new Intl.PluralRules(); var pluralRules = new Intl.PluralRules();
``` ```
...@@ -539,7 +539,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: PluralRulesOptions) ...@@ -539,7 +539,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: PluralRulesOptions)
| options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 | | options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 |
**示例:** **示例:**
``` ```js
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"}); var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
``` ```
...@@ -563,17 +563,17 @@ select(n: number): string ...@@ -563,17 +563,17 @@ select(n: number): string
| string | 单复数类别,取值包括:"zero","one","two",&nbsp;"few",&nbsp;"many",&nbsp;"others"。 | | string | 单复数类别,取值包括:"zero","one","two",&nbsp;"few",&nbsp;"many",&nbsp;"others"。 |
**示例:** **示例:**
``` ```js
var pluralRules = new Intl.PluralRules("zh-Hans"); var pluralRules = new Intl.PluralRules("zh-Hans");
pluralRules.select(1); pluralRules.select(1);
``` ```
## PluralRulesOptions<sup>8+</sup><a name=pluralrulesoptions></a> ## PluralRulesOptions<sup>8+</sup>
表示PluralRules对象可设置的属性。 表示PluralRules对象可设置的属性。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ---------------------------------------- | | ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
...@@ -598,7 +598,7 @@ constructor() ...@@ -598,7 +598,7 @@ constructor()
**系统能力**:SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
**示例:** **示例:**
``` ```js
var relativetimefmt = new Intl.RelativeTimeFormat(); var relativetimefmt = new Intl.RelativeTimeFormat();
``` ```
...@@ -618,7 +618,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: RelativeTimeFormatIn ...@@ -618,7 +618,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: RelativeTimeFormatIn
| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 | | options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 |
**示例:** **示例:**
``` ```js
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"}); var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
``` ```
...@@ -643,7 +643,7 @@ format(value: number, unit: string): string ...@@ -643,7 +643,7 @@ format(value: number, unit: string): string
| string | 格式化后的相对时间。 | | string | 格式化后的相对时间。 |
**示例:** **示例:**
``` ```js
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN"); var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter") relativetimefmt.format(3, "quarter")
``` ```
...@@ -669,7 +669,7 @@ formatToParts(value: number, unit: string): Array&lt;object&gt; ...@@ -669,7 +669,7 @@ formatToParts(value: number, unit: string): Array&lt;object&gt;
| Array&lt;object&gt; | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 | | Array&lt;object&gt; | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
**示例:** **示例:**
``` ```js
var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"}); var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
var parts = relativetimefmt.format(10, "seconds"); var parts = relativetimefmt.format(10, "seconds");
``` ```
...@@ -689,17 +689,17 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ...@@ -689,17 +689,17 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
| [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | RelativeTimeFormat&nbsp;对象的格式化选项。 | | [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | RelativeTimeFormat&nbsp;对象的格式化选项。 |
**示例:** **示例:**
``` ```js
var relativetimefmt= new Intl.RelativeTimeFormat("en-GB"); var relativetimefmt= new Intl.RelativeTimeFormat("en-GB");
relativetimefmt.resolvedOptions(); relativetimefmt.resolvedOptions();
``` ```
## RelativeTimeFormatInputOptions<sup>8+</sup><a name=relativetimeformatinputoptions></a> ## RelativeTimeFormatInputOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。 表示RelativeTimeFormat对象可设置的属性。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- | | ------------- | ------ | ---- | ---- | ---------------------------------------- |
...@@ -708,11 +708,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions ...@@ -708,11 +708,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
| style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 | | style | string | 是 | 是 | 国际化消息的长度,取值包括:"long",&nbsp;"short",&nbsp;"narrow"。 |
## RelativeTimeFormatResolvedOptions<sup>8+</sup><a name=relativetimeformatresolvedoptions></a> ## RelativeTimeFormatResolvedOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。 表示RelativeTimeFormat对象可设置的属性。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.I18n **系统能力**:SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | ---------------------------------------- | | --------------- | ------ | ---- | ---- | ---------------------------------------- |
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
KeyCode模块提供了按键类设备的键值。 KeyCode模块提供了按键类设备的键值。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -13,337 +13,337 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode' ...@@ -13,337 +13,337 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode'
## KeyCode ## KeyCode
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | -------------------------------- | ------ | ---- | ---- | --------------------------- |
| KEYCODE_FN | number | 是 | 否 | 功能(Fn)键 | | KEYCODE_FN | number | 是 | 否 | 功能(Fn)键 |
| KEYCODE_UNKNOWN | number | 是 | 否 | 未知按键 | | KEYCODE_UNKNOWN | number | 是 | 否 | 未知按键 |
| KEYCODE_HOME | number | 是 | 否 | 按键Home | | KEYCODE_HOME | number | 是 | 否 | 按键Home |
| KEYCODE_BACK | number | 是 | 否 | 返回键 | | KEYCODE_BACK | number | 是 | 否 | 返回键 |
| KEYCODE_MEDIA_PLAY_PAUSE | number | 是 | 否 | 多媒体键 播放/暂停 | | KEYCODE_MEDIA_PLAY_PAUSE | number | 是 | 否 | 多媒体键 播放/暂停 |
| KEYCODE_MEDIA_STOP | number | 是 | 否 | 多媒体键 停止 | | KEYCODE_MEDIA_STOP | number | 是 | 否 | 多媒体键 停止 |
| KEYCODE_MEDIA_NEXT | number | 是 | 否 | 多媒体键 下一首 | | KEYCODE_MEDIA_NEXT | number | 是 | 否 | 多媒体键 下一首 |
| KEYCODE_MEDIA_PREVIOUS | number | 是 | 否 | 多媒体键 上一首 | | KEYCODE_MEDIA_PREVIOUS | number | 是 | 否 | 多媒体键 上一首 |
| KEYCODE_MEDIA_REWIND | number | 是 | 否 | 多媒体键 快退 | | KEYCODE_MEDIA_REWIND | number | 是 | 否 | 多媒体键 快退 |
| KEYCODE_MEDIA_FAST_FORWARD | number | 是 | 否 | 多媒体键 快进 | | KEYCODE_MEDIA_FAST_FORWARD | number | 是 | 否 | 多媒体键 快进 |
| KEYCODE_VOLUME_UP | number | 是 | 否 | 音量增加键 | | KEYCODE_VOLUME_UP | number | 是 | 否 | 音量增加键 |
| KEYCODE_VOLUME_DOWN | number | 是 | 否 | 音量减小键 | | KEYCODE_VOLUME_DOWN | number | 是 | 否 | 音量减小键 |
| KEYCODE_POWER | number | 是 | 否 | 电源键 | | KEYCODE_POWER | number | 是 | 否 | 电源键 |
| KEYCODE_CAMERA | number | 是 | 否 | 拍照键 | | KEYCODE_CAMERA | number | 是 | 否 | 拍照键 |
| KEYCODE_VOLUME_MUTE | number | 是 | 否 | 扬声器静音键 | | KEYCODE_VOLUME_MUTE | number | 是 | 否 | 扬声器静音键 |
| KEYCODE_MUTE | number | 是 | 否 | 话筒静音键 | | KEYCODE_MUTE | number | 是 | 否 | 话筒静音键 |
| KEYCODE_BRIGHTNESS_UP | number | 是 | 否 | 亮度调节按键 调亮 | | KEYCODE_BRIGHTNESS_UP | number | 是 | 否 | 亮度调节按键 调亮 |
| KEYCODE_BRIGHTNESS_DOWN | number | 是 | 否 | 亮度调节按键 调暗 | | KEYCODE_BRIGHTNESS_DOWN | number | 是 | 否 | 亮度调节按键 调暗 |
| KEYCODE_0 | number | 是 | 否 | 按键'0' | | KEYCODE_0 | number | 是 | 否 | 按键'0' |
| KEYCODE_1 | number | 是 | 否 | 按键'1' | | KEYCODE_1 | number | 是 | 否 | 按键'1' |
| KEYCODE_2 | number | 是 | 否 | 按键'2' | | KEYCODE_2 | number | 是 | 否 | 按键'2' |
| KEYCODE_3 | number | 是 | 否 | 按键'3' | | KEYCODE_3 | number | 是 | 否 | 按键'3' |
| KEYCODE_4 | number | 是 | 否 | 按键'4' | | KEYCODE_4 | number | 是 | 否 | 按键'4' |
| KEYCODE_5 | number | 是 | 否 | 按键'5' | | KEYCODE_5 | number | 是 | 否 | 按键'5' |
| KEYCODE_6 | number | 是 | 否 | 按键'6' | | KEYCODE_6 | number | 是 | 否 | 按键'6' |
| KEYCODE_7 | number | 是 | 否 | 按键'7' | | KEYCODE_7 | number | 是 | 否 | 按键'7' |
| KEYCODE_8 | number | 是 | 否 | 按键'8' | | KEYCODE_8 | number | 是 | 否 | 按键'8' |
| KEYCODE_9 | number | 是 | 否 | 按键'9' | | KEYCODE_9 | number | 是 | 否 | 按键'9' |
| KEYCODE_STAR | number | 是 | 否 | 按键'*' | | KEYCODE_STAR | number | 是 | 否 | 按键'*' |
| KEYCODE_POUND | number | 是 | 否 | 按键'#' | | KEYCODE_POUND | number | 是 | 否 | 按键'#' |
| KEYCODE_DPAD_UP | number | 是 | 否 | 导航键 向上 | | KEYCODE_DPAD_UP | number | 是 | 否 | 导航键 向上 |
| KEYCODE_DPAD_DOWN | number | 是 | 否 | 导航键 向下 | | KEYCODE_DPAD_DOWN | number | 是 | 否 | 导航键 向下 |
| KEYCODE_DPAD_LEFT | number | 是 | 否 | 导航键 向左 | | KEYCODE_DPAD_LEFT | number | 是 | 否 | 导航键 向左 |
| KEYCODE_DPAD_RIGHT | number | 是 | 否 | 导航键 向右 | | KEYCODE_DPAD_RIGHT | number | 是 | 否 | 导航键 向右 |
| KEYCODE_DPAD_CENTER | number | 是 | 否 | 导航键 确定键 | | KEYCODE_DPAD_CENTER | number | 是 | 否 | 导航键 确定键 |
| KEYCODE_A | number | 是 | 否 | 按键'A' | | KEYCODE_A | number | 是 | 否 | 按键'A' |
| KEYCODE_B | number | 是 | 否 | 按键'B' | | KEYCODE_B | number | 是 | 否 | 按键'B' |
| KEYCODE_C | number | 是 | 否 | 按键'C' | | KEYCODE_C | number | 是 | 否 | 按键'C' |
| KEYCODE_D | number | 是 | 否 | 按键'D' | | KEYCODE_D | number | 是 | 否 | 按键'D' |
| KEYCODE_E | number | 是 | 否 | 按键'E' | | KEYCODE_E | number | 是 | 否 | 按键'E' |
| KEYCODE_F | number | 是 | 否 | 按键'F' | | KEYCODE_F | number | 是 | 否 | 按键'F' |
| KEYCODE_G | number | 是 | 否 | 按键'G' | | KEYCODE_G | number | 是 | 否 | 按键'G' |
| KEYCODE_H | number | 是 | 否 | 按键'H' | | KEYCODE_H | number | 是 | 否 | 按键'H' |
| KEYCODE_I | number | 是 | 否 | 按键'I' | | KEYCODE_I | number | 是 | 否 | 按键'I' |
| KEYCODE_J | number | 是 | 否 | 按键'J' | | KEYCODE_J | number | 是 | 否 | 按键'J' |
| KEYCODE_K | number | 是 | 否 | 按键'K' | | KEYCODE_K | number | 是 | 否 | 按键'K' |
| KEYCODE_L | number | 是 | 否 | 按键'L' | | KEYCODE_L | number | 是 | 否 | 按键'L' |
| KEYCODE_M | number | 是 | 否 | 按键'M' | | KEYCODE_M | number | 是 | 否 | 按键'M' |
| KEYCODE_N | number | 是 | 否 | 按键'N' | | KEYCODE_N | number | 是 | 否 | 按键'N' |
| KEYCODE_O | number | 是 | 否 | 按键'O' | | KEYCODE_O | number | 是 | 否 | 按键'O' |
| KEYCODE_P | number | 是 | 否 | 按键'P' | | KEYCODE_P | number | 是 | 否 | 按键'P' |
| KEYCODE_Q | number | 是 | 否 | 按键'Q' | | KEYCODE_Q | number | 是 | 否 | 按键'Q' |
| KEYCODE_R | number | 是 | 否 | 按键'R' | | KEYCODE_R | number | 是 | 否 | 按键'R' |
| KEYCODE_S | number | 是 | 否 | 按键'S' | | KEYCODE_S | number | 是 | 否 | 按键'S' |
| KEYCODE_T | number | 是 | 否 | 按键'T' | | KEYCODE_T | number | 是 | 否 | 按键'T' |
| KEYCODE_U | number | 是 | 否 | 按键'U' | | KEYCODE_U | number | 是 | 否 | 按键'U' |
| KEYCODE_V | number | 是 | 否 | 按键'V' | | KEYCODE_V | number | 是 | 否 | 按键'V' |
| KEYCODE_W | number | 是 | 否 | 按键'W' | | KEYCODE_W | number | 是 | 否 | 按键'W' |
| KEYCODE_X | number | 是 | 否 | 按键'X' | | KEYCODE_X | number | 是 | 否 | 按键'X' |
| KEYCODE_Y | number | 是 | 否 | 按键'Y' | | KEYCODE_Y | number | 是 | 否 | 按键'Y' |
| KEYCODE_Z | number | 是 | 否 | 按键'Z' | | KEYCODE_Z | number | 是 | 否 | 按键'Z' |
| KEYCODE_COMMA | number | 是 | 否 | 按键',' | | KEYCODE_COMMA | number | 是 | 否 | 按键',' |
| KEYCODE_PERIOD | number | 是 | 否 | 按键'.' | | KEYCODE_PERIOD | number | 是 | 否 | 按键'.' |
| KEYCODE_ALT_LEFT | number | 是 | 否 | Alt+Left | | KEYCODE_ALT_LEFT | number | 是 | 否 | Alt+Left |
| KEYCODE_ALT_RIGHT | number | 是 | 否 | Alt+Right | | KEYCODE_ALT_RIGHT | number | 是 | 否 | Alt+Right |
| KEYCODE_SHIFT_LEFT | number | 是 | 否 | Shift+Left | | KEYCODE_SHIFT_LEFT | number | 是 | 否 | Shift+Left |
| KEYCODE_SHIFT_RIGHT | number | 是 | 否 | Shift+Right | | KEYCODE_SHIFT_RIGHT | number | 是 | 否 | Shift+Right |
| KEYCODE_TAB | number | 是 | 否 | Tab键 | | KEYCODE_TAB | number | 是 | 否 | Tab键 |
| KEYCODE_SPACE | number | 是 | 否 | 空格键 | | KEYCODE_SPACE | number | 是 | 否 | 空格键 |
| KEYCODE_SYM | number | 是 | 否 | 符号修改器按键 | | KEYCODE_SYM | number | 是 | 否 | 符号修改器按键 |
| KEYCODE_EXPLORER | number | 是 | 否 | 浏览器功能键,此键用于启动浏览器应用程序。 | | KEYCODE_EXPLORER | number | 是 | 否 | 浏览器功能键,此键用于启动浏览器应用程序。 |
| KEYCODE_ENVELOPE | number | 是 | 否 | 电子邮件功能键,此键用于启动电子邮件应用程序。| | KEYCODE_ENVELOPE | number | 是 | 否 | 电子邮件功能键,此键用于启动电子邮件应用程序。 |
| KEYCODE_ENTER | number | 是 | 否 | 回车键 | | KEYCODE_ENTER | number | 是 | 否 | 回车键 |
| KEYCODE_DEL | number | 是 | 否 | 退格键 | | KEYCODE_DEL | number | 是 | 否 | 退格键 |
| KEYCODE_GRAVE | number | 是 | 否 | 按键'`' | | KEYCODE_GRAVE | number | 是 | 否 | 按键'`' |
| KEYCODE_MINUS | number | 是 | 否 | 按键'-' | | KEYCODE_MINUS | number | 是 | 否 | 按键'-' |
| KEYCODE_EQUALS | number | 是 | 否 | 按键'=' | | KEYCODE_EQUALS | number | 是 | 否 | 按键'=' |
| KEYCODE_LEFT_BRACKET | number | 是 | 否 | 按键'[' | | KEYCODE_LEFT_BRACKET | number | 是 | 否 | 按键'[' |
| KEYCODE_RIGHT_BRACKET | number | 是 | 否 | 按键']' | | KEYCODE_RIGHT_BRACKET | number | 是 | 否 | 按键']' |
| KEYCODE_BACKSLASH | number | 是 | 否 | 按键'\' | | KEYCODE_BACKSLASH | number | 是 | 否 | 按键'\' |
| KEYCODE_SEMICOLON | number | 是 | 否 | 按键';' | | KEYCODE_SEMICOLON | number | 是 | 否 | 按键';' |
| KEYCODE_APOSTROPHE | number | 是 | 否 | 按键''' (单引号) | | KEYCODE_APOSTROPHE | number | 是 | 否 | 按键''' (单引号) |
| KEYCODE_SLASH | number | 是 | 否 | 按键'/' | | KEYCODE_SLASH | number | 是 | 否 | 按键'/' |
| KEYCODE_AT | number | 是 | 否 | 按键'@' | | KEYCODE_AT | number | 是 | 否 | 按键'@' |
| KEYCODE_PLUS | number | 是 | 否 | 按键'+' | | KEYCODE_PLUS | number | 是 | 否 | 按键'+' |
| KEYCODE_MENU | number | 是 | 否 | 菜单键 | | KEYCODE_MENU | number | 是 | 否 | 菜单键 |
| KEYCODE_PAGE_UP | number | 是 | 否 | 向上翻页键 | | KEYCODE_PAGE_UP | number | 是 | 否 | 向上翻页键 |
| KEYCODE_PAGE_DOWN | number | 是 | 否 | 向下翻页键 | | KEYCODE_PAGE_DOWN | number | 是 | 否 | 向下翻页键 |
| KEYCODE_ESCAPE | number | 是 | 否 | ESC键 | | KEYCODE_ESCAPE | number | 是 | 否 | ESC键 |
| KEYCODE_FORWARD_DEL | number | 是 | 否 | 删除键 | | KEYCODE_FORWARD_DEL | number | 是 | 否 | 删除键 |
| KEYCODE_CTRL_LEFT | number | 是 | 否 | Control+Left | | KEYCODE_CTRL_LEFT | number | 是 | 否 | Control+Left |
| KEYCODE_CTRL_RIGHT | number | 是 | 否 | Control+Right | | KEYCODE_CTRL_RIGHT | number | 是 | 否 | Control+Right |
| KEYCODE_CAPS_LOCK | number | 是 | 否 | 大写锁定键 | | KEYCODE_CAPS_LOCK | number | 是 | 否 | 大写锁定键 |
| KEYCODE_SCROLL_LOCK | number | 是 | 否 | 滚动锁定键 | | KEYCODE_SCROLL_LOCK | number | 是 | 否 | 滚动锁定键 |
| KEYCODE_META_LEFT | number | 是 | 否 | 左元修改器键 | | KEYCODE_META_LEFT | number | 是 | 否 | 左元修改器键 |
| KEYCODE_META_RIGHT | number | 是 | 否 | 右元修改器键 | | KEYCODE_META_RIGHT | number | 是 | 否 | 右元修改器键 |
| KEYCODE_FUNCTION | number | 是 | 否 | 函数修改器键 | | KEYCODE_FUNCTION | number | 是 | 否 | 函数修改器键 |
| KEYCODE_SYSRQ | number | 是 | 否 | 系统请求/打印屏幕键 | | KEYCODE_SYSRQ | number | 是 | 否 | 系统请求/打印屏幕键 |
| KEYCODE_BREAK | number | 是 | 否 | Break/Pause键 | | KEYCODE_BREAK | number | 是 | 否 | Break/Pause键 |
| KEYCODE_MOVE_HOME | number | 是 | 否 | 光标移动到开始键 | | KEYCODE_MOVE_HOME | number | 是 | 否 | 光标移动到开始键 |
| KEYCODE_MOVE_END | number | 是 | 否 | 光标移动到末尾键 | | KEYCODE_MOVE_END | number | 是 | 否 | 光标移动到末尾键 |
| KEYCODE_INSERT | number | 是 | 否 | 插入键 | | KEYCODE_INSERT | number | 是 | 否 | 插入键 |
| KEYCODE_FORWARD | number | 是 | 否 | 删除键 | | KEYCODE_FORWARD | number | 是 | 否 | 删除键 |
| KEYCODE_MEDIA_PLAY | number | 是 | 否 | 多媒体键 播放 | | KEYCODE_MEDIA_PLAY | number | 是 | 否 | 多媒体键 播放 |
| KEYCODE_MEDIA_PAUSE | number | 是 | 否 | 多媒体键 暂停 | | KEYCODE_MEDIA_PAUSE | number | 是 | 否 | 多媒体键 暂停 |
| KEYCODE_MEDIA_CLOSE | number | 是 | 否 | 多媒体键 关闭 | | KEYCODE_MEDIA_CLOSE | number | 是 | 否 | 多媒体键 关闭 |
| KEYCODE_MEDIA_EJECT | number | 是 | 否 | 多媒体键 弹出 | | KEYCODE_MEDIA_EJECT | number | 是 | 否 | 多媒体键 弹出 |
| KEYCODE_MEDIA_RECORD | number | 是 | 否 | 多媒体键 录音 | | KEYCODE_MEDIA_RECORD | number | 是 | 否 | 多媒体键 录音 |
| KEYCODE_F1 | number | 是 | 否 | 按键'F1' | | KEYCODE_F1 | number | 是 | 否 | 按键'F1' |
| KEYCODE_F2 | number | 是 | 否 | 按键'F2' | | KEYCODE_F2 | number | 是 | 否 | 按键'F2' |
| KEYCODE_F3 | number | 是 | 否 | 按键'F3' | | KEYCODE_F3 | number | 是 | 否 | 按键'F3' |
| KEYCODE_F4 | number | 是 | 否 | 按键'F4' | | KEYCODE_F4 | number | 是 | 否 | 按键'F4' |
| KEYCODE_F5 | number | 是 | 否 | 按键'F5' | | KEYCODE_F5 | number | 是 | 否 | 按键'F5' |
| KEYCODE_F6 | number | 是 | 否 | 按键'F6' | | KEYCODE_F6 | number | 是 | 否 | 按键'F6' |
| KEYCODE_F7 | number | 是 | 否 | 按键'F7' | | KEYCODE_F7 | number | 是 | 否 | 按键'F7' |
| KEYCODE_F8 | number | 是 | 否 | 按键'F8' | | KEYCODE_F8 | number | 是 | 否 | 按键'F8' |
| KEYCODE_F9 | number | 是 | 否 | 按键'F9' | | KEYCODE_F9 | number | 是 | 否 | 按键'F9' |
| KEYCODE_F10 | number | 是 | 否 | 按键'F10' | | KEYCODE_F10 | number | 是 | 否 | 按键'F10' |
| KEYCODE_F11 | number | 是 | 否 | 按键'F11' | | KEYCODE_F11 | number | 是 | 否 | 按键'F11' |
| KEYCODE_F12 | number | 是 | 否 | 按键'F12' | | KEYCODE_F12 | number | 是 | 否 | 按键'F12' |
| KEYCODE_NUM_LOCK | number | 是 | 否 | 小键盘锁 | | KEYCODE_NUM_LOCK | number | 是 | 否 | 小键盘锁 |
| KEYCODE_NUMPAD_0 | number | 是 | 否 | 小键盘按键'0' | | KEYCODE_NUMPAD_0 | number | 是 | 否 | 小键盘按键'0' |
| KEYCODE_NUMPAD_1 | number | 是 | 否 | 小键盘按键'1' | | KEYCODE_NUMPAD_1 | number | 是 | 否 | 小键盘按键'1' |
| KEYCODE_NUMPAD_2 | number | 是 | 否 | 小键盘按键'2' | | KEYCODE_NUMPAD_2 | number | 是 | 否 | 小键盘按键'2' |
| KEYCODE_NUMPAD_3 | number | 是 | 否 | 小键盘按键'3' | | KEYCODE_NUMPAD_3 | number | 是 | 否 | 小键盘按键'3' |
| KEYCODE_NUMPAD_4 | number | 是 | 否 | 小键盘按键'4' | | KEYCODE_NUMPAD_4 | number | 是 | 否 | 小键盘按键'4' |
| KEYCODE_NUMPAD_5 | number | 是 | 否 | 小键盘按键'5' | | KEYCODE_NUMPAD_5 | number | 是 | 否 | 小键盘按键'5' |
| KEYCODE_NUMPAD_6 | number | 是 | 否 | 小键盘按键'6' | | KEYCODE_NUMPAD_6 | number | 是 | 否 | 小键盘按键'6' |
| KEYCODE_NUMPAD_7 | number | 是 | 否 | 小键盘按键'7' | | KEYCODE_NUMPAD_7 | number | 是 | 否 | 小键盘按键'7' |
| KEYCODE_NUMPAD_8 | number | 是 | 否 | 小键盘按键'8' | | KEYCODE_NUMPAD_8 | number | 是 | 否 | 小键盘按键'8' |
| KEYCODE_NUMPAD_9 | number | 是 | 否 | 小键盘按键'9' | | KEYCODE_NUMPAD_9 | number | 是 | 否 | 小键盘按键'9' |
| KEYCODE_NUMPAD_DIVIDE | number | 是 | 否 | 小键盘按键'/' | | KEYCODE_NUMPAD_DIVIDE | number | 是 | 否 | 小键盘按键'/' |
| KEYCODE_NUMPAD_MULTIPLY | number | 是 | 否 | 小键盘按键'*' | | KEYCODE_NUMPAD_MULTIPLY | number | 是 | 否 | 小键盘按键'*' |
| KEYCODE_NUMPAD_SUBTRACT | number | 是 | 否 | 小键盘按键'-' | | KEYCODE_NUMPAD_SUBTRACT | number | 是 | 否 | 小键盘按键'-' |
| KEYCODE_NUMPAD_ADD | number | 是 | 否 | 小键盘按键'+' | | KEYCODE_NUMPAD_ADD | number | 是 | 否 | 小键盘按键'+' |
| KEYCODE_NUMPAD_DOT | number | 是 | 否 | 小键盘按键'.' | | KEYCODE_NUMPAD_DOT | number | 是 | 否 | 小键盘按键'.' |
| KEYCODE_NUMPAD_COMMA | number | 是 | 否 | 小键盘按键',' | | KEYCODE_NUMPAD_COMMA | number | 是 | 否 | 小键盘按键',' |
| KEYCODE_NUMPAD_ENTER | number | 是 | 否 | 小键盘按键回车 | | KEYCODE_NUMPAD_ENTER | number | 是 | 否 | 小键盘按键回车 |
| KEYCODE_NUMPAD_EQUALS | number | 是 | 否 | 小键盘按键'=' | | KEYCODE_NUMPAD_EQUALS | number | 是 | 否 | 小键盘按键'=' |
| KEYCODE_NUMPAD_LEFT_PAREN | number | 是 | 否 | 小键盘按键'(' | | KEYCODE_NUMPAD_LEFT_PAREN | number | 是 | 否 | 小键盘按键'(' |
| KEYCODE_NUMPAD_RIGHT_PAREN | number | 是 | 否 | 小键盘按键')' | | KEYCODE_NUMPAD_RIGHT_PAREN | number | 是 | 否 | 小键盘按键')' |
| KEYCODE_VIRTUAL_MULTITASK | number | 是 | 否 | 虚拟多任务键 | | KEYCODE_VIRTUAL_MULTITASK | number | 是 | 否 | 虚拟多任务键 |
| KEYCODE_SLEEP | number | 是 | 否 | 睡眠键 | | KEYCODE_SLEEP | number | 是 | 否 | 睡眠键 |
| KEYCODE_ZENKAKU_HANKAKU | number | 是 | 否 | 日文全宽/半宽键 | | KEYCODE_ZENKAKU_HANKAKU | number | 是 | 否 | 日文全宽/半宽键 |
| KEYCODE_102ND | number | 是 | 否 | 102nd按键 | | KEYCODE_102ND | number | 是 | 否 | 102nd按键 |
| KEYCODE_RO | number | 是 | 否 | 日文Ro键 | | KEYCODE_RO | number | 是 | 否 | 日文Ro键 |
| KEYCODE_KATAKANA | number | 是 | 否 | 日文片假名键 | | KEYCODE_KATAKANA | number | 是 | 否 | 日文片假名键 |
| KEYCODE_HIRAGANA | number | 是 | 否 | 日文平假名键 | | KEYCODE_HIRAGANA | number | 是 | 否 | 日文平假名键 |
| KEYCODE_HENKAN | number | 是 | 否 | 日文转换键 | | KEYCODE_HENKAN | number | 是 | 否 | 日文转换键 |
| KEYCODE_KATAKANA_HIRAGANA | number | 是 | 否 | 日语片假名/平假名键 | | KEYCODE_KATAKANA_HIRAGANA | number | 是 | 否 | 日语片假名/平假名键 |
| KEYCODE_MUHENKAN | number | 是 | 否 | 日文非转换键 | | KEYCODE_MUHENKAN | number | 是 | 否 | 日文非转换键 |
| KEYCODE_LINEFEED | number | 是 | 否 | 换行键 | | KEYCODE_LINEFEED | number | 是 | 否 | 换行键 |
| KEYCODE_MACRO | number | 是 | 否 | 宏键 | | KEYCODE_MACRO | number | 是 | 否 | 宏键 |
| KEYCODE_NUMPAD_PLUSMINUS | number | 是 | 否 | 数字键盘上的加号/减号键 | | KEYCODE_NUMPAD_PLUSMINUS | number | 是 | 否 | 数字键盘上的加号/减号键 |
| KEYCODE_SCALE | number | 是 | 否 | 扩展键 | | KEYCODE_SCALE | number | 是 | 否 | 扩展键 |
| KEYCODE_HANGUEL | number | 是 | 否 | 日文韩语键 | | KEYCODE_HANGUEL | number | 是 | 否 | 日文韩语键 |
| KEYCODE_HANJA | number | 是 | 否 | 日文汉语键 | | KEYCODE_HANJA | number | 是 | 否 | 日文汉语键 |
| KEYCODE_YEN | number | 是 | 否 | 日元键 | | KEYCODE_YEN | number | 是 | 否 | 日元键 |
| KEYCODE_STOP | number | 是 | 否 | 停止键 | | KEYCODE_STOP | number | 是 | 否 | 停止键 |
| KEYCODE_AGAIN | number | 是 | 否 | 重复键 | | KEYCODE_AGAIN | number | 是 | 否 | 重复键 |
| KEYCODE_PROPS | number | 是 | 否 | 道具键 | | KEYCODE_PROPS | number | 是 | 否 | 道具键 |
| KEYCODE_UNDO | number | 是 | 否 | 撤消键 | | KEYCODE_UNDO | number | 是 | 否 | 撤消键 |
| KEYCODE_COPY | number | 是 | 否 | 复制键 | | KEYCODE_COPY | number | 是 | 否 | 复制键 |
| KEYCODE_OPEN | number | 是 | 否 | 打开键 | | KEYCODE_OPEN | number | 是 | 否 | 打开键 |
| KEYCODE_PASTE | number | 是 | 否 | 粘贴键 | | KEYCODE_PASTE | number | 是 | 否 | 粘贴键 |
| KEYCODE_FIND | number | 是 | 否 | 查找键 | | KEYCODE_FIND | number | 是 | 否 | 查找键 |
| KEYCODE_CUT | number | 是 | 否 | 剪切键 | | KEYCODE_CUT | number | 是 | 否 | 剪切键 |
| KEYCODE_HELP | number | 是 | 否 | 帮助键 | | KEYCODE_HELP | number | 是 | 否 | 帮助键 |
| KEYCODE_CALC | number | 是 | 否 | 计算器特殊功能键,用于启动计算器应用程序 | | KEYCODE_CALC | number | 是 | 否 | 计算器特殊功能键,用于启动计算器应用程序 |
| KEYCODE_FILE | number | 是 | 否 | 文件按键 | | KEYCODE_FILE | number | 是 | 否 | 文件按键 |
| KEYCODE_BOOKMARKS | number | 是 | 否 | 书签键 | | KEYCODE_BOOKMARKS | number | 是 | 否 | 书签键 |
| KEYCODE_NEXT | number | 是 | 否 | 下一个按键 | | KEYCODE_NEXT | number | 是 | 否 | 下一个按键 |
| KEYCODE_PLAYPAUSE | number | 是 | 否 | 播放/暂停键 | | KEYCODE_PLAYPAUSE | number | 是 | 否 | 播放/暂停键 |
| KEYCODE_PREVIOUS | number | 是 | 否 | 上一个按键 | | KEYCODE_PREVIOUS | number | 是 | 否 | 上一个按键 |
| KEYCODE_STOPCD | number | 是 | 否 | CD停止键 | | KEYCODE_STOPCD | number | 是 | 否 | CD停止键 |
| KEYCODE_CONFIG | number | 是 | 否 | 配置键 | | KEYCODE_CONFIG | number | 是 | 否 | 配置键 |
| KEYCODE_REFRESH | number | 是 | 否 | 刷新键 | | KEYCODE_REFRESH | number | 是 | 否 | 刷新键 |
| KEYCODE_EXIT | number | 是 | 否 | 退出键 | | KEYCODE_EXIT | number | 是 | 否 | 退出键 |
| KEYCODE_EDIT | number | 是 | 否 | 编辑键 | | KEYCODE_EDIT | number | 是 | 否 | 编辑键 |
| KEYCODE_SCROLLUP | number | 是 | 否 | 向上滚动键 | | KEYCODE_SCROLLUP | number | 是 | 否 | 向上滚动键 |
| KEYCODE_SCROLLDOWN | number | 是 | 否 | 向下滚动键 | | KEYCODE_SCROLLDOWN | number | 是 | 否 | 向下滚动键 |
| KEYCODE_NEW | number | 是 | 否 | 新建键 | | KEYCODE_NEW | number | 是 | 否 | 新建键 |
| KEYCODE_REDO | number | 是 | 否 | 恢复键 | | KEYCODE_REDO | number | 是 | 否 | 恢复键 |
| KEYCODE_CLOSE | number | 是 | 否 | 关闭键 | | KEYCODE_CLOSE | number | 是 | 否 | 关闭键 |
| KEYCODE_PLAY | number | 是 | 否 | 播放键 | | KEYCODE_PLAY | number | 是 | 否 | 播放键 |
| KEYCODE_BASSBOOST | number | 是 | 否 | 低音增强键 | | KEYCODE_BASSBOOST | number | 是 | 否 | 低音增强键 |
| KEYCODE_PRINT | number | 是 | 否 | 打印键 | | KEYCODE_PRINT | number | 是 | 否 | 打印键 |
| KEYCODE_CHAT | number | 是 | 否 | 聊天键 | | KEYCODE_CHAT | number | 是 | 否 | 聊天键 |
| KEYCODE_FINANCE | number | 是 | 否 | 金融键 | | KEYCODE_FINANCE | number | 是 | 否 | 金融键 |
| KEYCODE_CANCEL | number | 是 | 否 | 取消键 | | KEYCODE_CANCEL | number | 是 | 否 | 取消键 |
| KEYCODE_KBDILLUM_TOGGLE | number | 是 | 否 | 键盘灯光切换键 | | KEYCODE_KBDILLUM_TOGGLE | number | 是 | 否 | 键盘灯光切换键 |
| KEYCODE_KBDILLUM_DOWN | number | 是 | 否 | 键盘灯光调亮键 | | KEYCODE_KBDILLUM_DOWN | number | 是 | 否 | 键盘灯光调亮键 |
| KEYCODE_KBDILLUM_UP | number | 是 | 否 | 键盘灯光调暗键 | | KEYCODE_KBDILLUM_UP | number | 是 | 否 | 键盘灯光调暗键 |
| KEYCODE_SEND | number | 是 | 否 | 发送键 | | KEYCODE_SEND | number | 是 | 否 | 发送键 |
| KEYCODE_REPLY | number | 是 | 否 | 答复键 | | KEYCODE_REPLY | number | 是 | 否 | 答复键 |
| KEYCODE_FORWARDMAIL | number | 是 | 否 | 邮件转发键 | | KEYCODE_FORWARDMAIL | number | 是 | 否 | 邮件转发键 |
| KEYCODE_SAVE | number | 是 | 否 | 保存键 | | KEYCODE_SAVE | number | 是 | 否 | 保存键 |
| KEYCODE_DOCUMENTS | number | 是 | 否 | 文件键 | | KEYCODE_DOCUMENTS | number | 是 | 否 | 文件键 |
| KEYCODE_VIDEO_NEXT | number | 是 | 否 | 下一个视频键 | | KEYCODE_VIDEO_NEXT | number | 是 | 否 | 下一个视频键 |
| KEYCODE_VIDEO_PREV | number | 是 | 否 | 上一个视频键 | | KEYCODE_VIDEO_PREV | number | 是 | 否 | 上一个视频键 |
| KEYCODE_BRIGHTNESS_CYCLE | number | 是 | 否 | 背光渐变键 | | KEYCODE_BRIGHTNESS_CYCLE | number | 是 | 否 | 背光渐变键 |
| KEYCODE_BRIGHTNESS_ZERO | number | 是 | 否 | 亮度调节为0键 | | KEYCODE_BRIGHTNESS_ZERO | number | 是 | 否 | 亮度调节为0键 |
| KEYCODE_DISPLAY_OFF | number | 是 | 否 | 显示关闭键 | | KEYCODE_DISPLAY_OFF | number | 是 | 否 | 显示关闭键 |
| KEYCODE_BTN_MISC | number | 是 | 否 | 游戏手柄上的各种按键 | | KEYCODE_BTN_MISC | number | 是 | 否 | 游戏手柄上的各种按键 |
| KEYCODE_GOTO | number | 是 | 否 | 进入键 | | KEYCODE_GOTO | number | 是 | 否 | 进入键 |
| KEYCODE_INFO | number | 是 | 否 | 信息查看键 | | KEYCODE_INFO | number | 是 | 否 | 信息查看键 |
| KEYCODE_PROGRAM | number | 是 | 否 | 程序键 | | KEYCODE_PROGRAM | number | 是 | 否 | 程序键 |
| KEYCODE_PVR | number | 是 | 否 | 个人录像机(PVR)键 | | KEYCODE_PVR | number | 是 | 否 | 个人录像机(PVR)键 |
| KEYCODE_SUBTITLE | number | 是 | 否 | 字幕键 | | KEYCODE_SUBTITLE | number | 是 | 否 | 字幕键 |
| KEYCODE_FULL_SCREEN | number | 是 | 否 | 全屏键 | | KEYCODE_FULL_SCREEN | number | 是 | 否 | 全屏键 |
| KEYCODE_KEYBOARD | number | 是 | 否 | 键盘 | | KEYCODE_KEYBOARD | number | 是 | 否 | 键盘 |
| KEYCODE_ASPECT_RATIO | number | 是 | 否 | 屏幕纵横比调节键 | | KEYCODE_ASPECT_RATIO | number | 是 | 否 | 屏幕纵横比调节键 |
| KEYCODE_PC | number | 是 | 否 | 端口控制键 | | KEYCODE_PC | number | 是 | 否 | 端口控制键 |
| KEYCODE_TV | number | 是 | 否 | TV键 | | KEYCODE_TV | number | 是 | 否 | TV键 |
| KEYCODE_TV2 | number | 是 | 否 | TV键2 | | KEYCODE_TV2 | number | 是 | 否 | TV键2 |
| KEYCODE_VCR | number | 是 | 否 | 录像机开启键 | | KEYCODE_VCR | number | 是 | 否 | 录像机开启键 |
| KEYCODE_VCR2 | number | 是 | 否 | 录像机开启键2 | | KEYCODE_VCR2 | number | 是 | 否 | 录像机开启键2 |
| KEYCODE_SAT | number | 是 | 否 | SIM卡应用工具包(SAT)键 | | KEYCODE_SAT | number | 是 | 否 | SIM卡应用工具包(SAT)键 |
| KEYCODE_CD | number | 是 | 否 | CD键 | | KEYCODE_CD | number | 是 | 否 | CD键 |
| KEYCODE_TAPE | number | 是 | 否 | 磁带键 | | KEYCODE_TAPE | number | 是 | 否 | 磁带键 |
| KEYCODE_TUNER | number | 是 | 否 | 调谐器键 | | KEYCODE_TUNER | number | 是 | 否 | 调谐器键 |
| KEYCODE_PLAYER | number | 是 | 否 | 播放器键 | | KEYCODE_PLAYER | number | 是 | 否 | 播放器键 |
| KEYCODE_DVD | number | 是 | 否 | DVD键 | | KEYCODE_DVD | number | 是 | 否 | DVD键 |
| KEYCODE_AUDIO | number | 是 | 否 | 音频键 | | KEYCODE_AUDIO | number | 是 | 否 | 音频键 |
| KEYCODE_VIDEO | number | 是 | 否 | 视频键 | | KEYCODE_VIDEO | number | 是 | 否 | 视频键 |
| KEYCODE_MEMO | number | 是 | 否 | 备忘录键 | | KEYCODE_MEMO | number | 是 | 否 | 备忘录键 |
| KEYCODE_CALENDAR | number | 是 | 否 | 日历键 | | KEYCODE_CALENDAR | number | 是 | 否 | 日历键 |
| KEYCODE_RED | number | 是 | 否 | 红色指示器 | | KEYCODE_RED | number | 是 | 否 | 红色指示器 |
| KEYCODE_GREEN | number | 是 | 否 | 绿色指示器 | | KEYCODE_GREEN | number | 是 | 否 | 绿色指示器 |
| KEYCODE_YELLOW | number | 是 | 否 | 黄色指示器 | | KEYCODE_YELLOW | number | 是 | 否 | 黄色指示器 |
| KEYCODE_BLUE | number | 是 | 否 | 蓝色指示器 | | KEYCODE_BLUE | number | 是 | 否 | 蓝色指示器 |
| KEYCODE_CHANNELUP | number | 是 | 否 | 频道向上键 | | KEYCODE_CHANNELUP | number | 是 | 否 | 频道向上键 |
| KEYCODE_CHANNELDOWN | number | 是 | 否 | 频道向下键 | | KEYCODE_CHANNELDOWN | number | 是 | 否 | 频道向下键 |
| KEYCODE_LAST | number | 是 | 否 | 末尾键 | | KEYCODE_LAST | number | 是 | 否 | 末尾键 |
| KEYCODE_RESTART | number | 是 | 否 | 重启键 | | KEYCODE_RESTART | number | 是 | 否 | 重启键 |
| KEYCODE_SLOW | number | 是 | 否 | 慢速键 | | KEYCODE_SLOW | number | 是 | 否 | 慢速键 |
| KEYCODE_SHUFFLE | number | 是 | 否 | 随机播放键 | | KEYCODE_SHUFFLE | number | 是 | 否 | 随机播放键 |
| KEYCODE_VIDEOPHONE | number | 是 | 否 | 可视电话键 | | KEYCODE_VIDEOPHONE | number | 是 | 否 | 可视电话键 |
| KEYCODE_GAMES | number | 是 | 否 | 游戏键 | | KEYCODE_GAMES | number | 是 | 否 | 游戏键 |
| KEYCODE_ZOOMIN | number | 是 | 否 | 放大键 | | KEYCODE_ZOOMIN | number | 是 | 否 | 放大键 |
| KEYCODE_ZOOMOUT | number | 是 | 否 | 缩小键 | | KEYCODE_ZOOMOUT | number | 是 | 否 | 缩小键 |
| KEYCODE_ZOOMRESET | number | 是 | 否 | 缩放重置键 | | KEYCODE_ZOOMRESET | number | 是 | 否 | 缩放重置键 |
| KEYCODE_WORDPROCESSOR | number | 是 | 否 | 文字处理键 | | KEYCODE_WORDPROCESSOR | number | 是 | 否 | 文字处理键 |
| KEYCODE_EDITOR | number | 是 | 否 | 编辑器键 | | KEYCODE_EDITOR | number | 是 | 否 | 编辑器键 |
| KEYCODE_SPREADSHEET | number | 是 | 否 | 电子表格键 | | KEYCODE_SPREADSHEET | number | 是 | 否 | 电子表格键 |
| KEYCODE_GRAPHICSEDITOR | number | 是 | 否 | 图形编辑器键 | | KEYCODE_GRAPHICSEDITOR | number | 是 | 否 | 图形编辑器键 |
| KEYCODE_PRESENTATION | number | 是 | 否 | 演示文稿键 | | KEYCODE_PRESENTATION | number | 是 | 否 | 演示文稿键 |
| KEYCODE_DATABASE | number | 是 | 否 | 数据库键标 | | KEYCODE_DATABASE | number | 是 | 否 | 数据库键标 |
| KEYCODE_NEWS | number | 是 | 否 | 新闻键 | | KEYCODE_NEWS | number | 是 | 否 | 新闻键 |
| KEYCODE_VOICEMAIL | number | 是 | 否 | 语音信箱 | | KEYCODE_VOICEMAIL | number | 是 | 否 | 语音信箱 |
| KEYCODE_ADDRESSBOOK | number | 是 | 否 | 通讯簿 | | KEYCODE_ADDRESSBOOK | number | 是 | 否 | 通讯簿 |
| KEYCODE_MESSENGER | number | 是 | 否 | 通信键 | | KEYCODE_MESSENGER | number | 是 | 否 | 通信键 |
| KEYCODE_BRIGHTNESS_TOGGLE | number | 是 | 否 | 亮度切换键 | | KEYCODE_BRIGHTNESS_TOGGLE | number | 是 | 否 | 亮度切换键 |
| KEYCODE_SPELLCHECK | number | 是 | 否 | AL拼写检查 | | KEYCODE_SPELLCHECK | number | 是 | 否 | AL拼写检查 |
| KEYCODE_COFFEE | number | 是 | 否 | 终端锁/屏幕保护程序 | | KEYCODE_COFFEE | number | 是 | 否 | 终端锁/屏幕保护程序 |
| KEYCODE_MEDIA_REPEAT | number | 是 | 否 | 媒体循环键 | | KEYCODE_MEDIA_REPEAT | number | 是 | 否 | 媒体循环键 |
| KEYCODE_IMAGES | number | 是 | 否 | 图像键 | | KEYCODE_IMAGES | number | 是 | 否 | 图像键 |
| KEYCODE_BUTTONCONFIG | number | 是 | 否 | 按键配置键 | | KEYCODE_BUTTONCONFIG | number | 是 | 否 | 按键配置键 |
| KEYCODE_TASKMANAGER | number | 是 | 否 | 任务管理器 | | KEYCODE_TASKMANAGER | number | 是 | 否 | 任务管理器 |
| KEYCODE_JOURNAL | number | 是 | 否 | 日志按键 | | KEYCODE_JOURNAL | number | 是 | 否 | 日志按键 |
| KEYCODE_CONTROLPANEL | number | 是 | 否 | 控制面板键 | | KEYCODE_CONTROLPANEL | number | 是 | 否 | 控制面板键 |
| KEYCODE_APPSELECT | number | 是 | 否 | 应用程序选择键 | | KEYCODE_APPSELECT | number | 是 | 否 | 应用程序选择键 |
| KEYCODE_SCREENSAVER | number | 是 | 否 | 屏幕保护程序键 | | KEYCODE_SCREENSAVER | number | 是 | 否 | 屏幕保护程序键 |
| KEYCODE_ASSISTANT | number | 是 | 否 | 辅助键 | | KEYCODE_ASSISTANT | number | 是 | 否 | 辅助键 |
| KEYCODE_KBD_LAYOUT_NEXT | number | 是 | 否 | 下一个键盘布局键 | | KEYCODE_KBD_LAYOUT_NEXT | number | 是 | 否 | 下一个键盘布局键 |
| KEYCODE_BRIGHTNESS_MIN | number | 是 | 否 | 最小亮度键 | | KEYCODE_BRIGHTNESS_MIN | number | 是 | 否 | 最小亮度键 |
| KEYCODE_BRIGHTNESS_MAX | number | 是 | 否 | 最大亮度键 | | KEYCODE_BRIGHTNESS_MAX | number | 是 | 否 | 最大亮度键 |
| KEYCODE_KBDINPUTASSIST_PREV | number | 是 | 否 | 键盘输入Assist_Previous | | KEYCODE_KBDINPUTASSIST_PREV | number | 是 | 否 | 键盘输入Assist_Previous |
| KEYCODE_KBDINPUTASSIST_NEXT | number | 是 | 否 | 键盘输入Assist_Next | | KEYCODE_KBDINPUTASSIST_NEXT | number | 是 | 否 | 键盘输入Assist_Next |
| KEYCODE_KBDINPUTASSIST_PREVGROUP | number | 是 | 否 | 键盘输入Assist_Previous | | KEYCODE_KBDINPUTASSIST_PREVGROUP | number | 是 | 否 | 键盘输入Assist_Previous |
| KEYCODE_KBDINPUTASSIST_NEXTGROUP | number | 是 | 否 | 键盘输入Assist_Next | | KEYCODE_KBDINPUTASSIST_NEXTGROUP | number | 是 | 否 | 键盘输入Assist_Next |
| KEYCODE_KBDINPUTASSIST_ACCEPT | number | 是 | 否 | 键盘输入Assist_Accept | | KEYCODE_KBDINPUTASSIST_ACCEPT | number | 是 | 否 | 键盘输入Assist_Accept |
| KEYCODE_KBDINPUTASSIST_CANCEL | number | 是 | 否 | 键盘输入Assist_Cancel | | KEYCODE_KBDINPUTASSIST_CANCEL | number | 是 | 否 | 键盘输入Assist_Cancel |
| KEYCODE_FRONT | number | 是 | 否 | 挡风玻璃除雾器开关 | | KEYCODE_FRONT | number | 是 | 否 | 挡风玻璃除雾器开关 |
| KEYCODE_SETUP | number | 是 | 否 | 设置键 | | KEYCODE_SETUP | number | 是 | 否 | 设置键 |
| KEYCODE_WAKEUP | number | 是 | 否 | 唤醒键 | | KEYCODE_WAKEUP | number | 是 | 否 | 唤醒键 |
| KEYCODE_SENDFILE | number | 是 | 否 | 发送文件按键 | | KEYCODE_SENDFILE | number | 是 | 否 | 发送文件按键 |
| KEYCODE_DELETEFILE | number | 是 | 否 | 删除文件按键 | | KEYCODE_DELETEFILE | number | 是 | 否 | 删除文件按键 |
| KEYCODE_XFER | number | 是 | 否 | 文件传输(XFER)按键 | | KEYCODE_XFER | number | 是 | 否 | 文件传输(XFER)按键 |
| KEYCODE_PROG1 | number | 是 | 否 | 程序键1 | | KEYCODE_PROG1 | number | 是 | 否 | 程序键1 |
| KEYCODE_PROG2 | number | 是 | 否 | 程序键2 | | KEYCODE_PROG2 | number | 是 | 否 | 程序键2 |
| KEYCODE_MSDOS | number | 是 | 否 | MS-DOS键(微软磁盘操作系统 | | KEYCODE_MSDOS | number | 是 | 否 | MS-DOS键(微软磁盘操作系统 |
| KEYCODE_SCREENLOCK | number | 是 | 否 | 屏幕锁定键 | | KEYCODE_SCREENLOCK | number | 是 | 否 | 屏幕锁定键 |
| KEYCODE_DIRECTION_ROTATE_DISPLAY | number | 是 | 否 | 方向旋转显示键 | | KEYCODE_DIRECTION_ROTATE_DISPLAY | number | 是 | 否 | 方向旋转显示键 |
| KEYCODE_CYCLEWINDOWS | number | 是 | 否 | Windows循环键 | | KEYCODE_CYCLEWINDOWS | number | 是 | 否 | Windows循环键 |
| KEYCODE_COMPUTER | number | 是 | 否 | 按键 | | KEYCODE_COMPUTER | number | 是 | 否 | 按键 |
| KEYCODE_EJECTCLOSECD | number | 是 | 否 | 弹出CD键 | | KEYCODE_EJECTCLOSECD | number | 是 | 否 | 弹出CD键 |
| KEYCODE_ISO | number | 是 | 否 | ISO键 | | KEYCODE_ISO | number | 是 | 否 | ISO键 |
| KEYCODE_MOVE | number | 是 | 否 | 移动键 | | KEYCODE_MOVE | number | 是 | 否 | 移动键 |
| KEYCODE_F13 | number | 是 | 否 | 按键'F13' | | KEYCODE_F13 | number | 是 | 否 | 按键'F13' |
| KEYCODE_F14 | number | 是 | 否 | 按键'F14' | | KEYCODE_F14 | number | 是 | 否 | 按键'F14' |
| KEYCODE_F15 | number | 是 | 否 | 按键'F15' | | KEYCODE_F15 | number | 是 | 否 | 按键'F15' |
| KEYCODE_F16 | number | 是 | 否 | 按键'F16' | | KEYCODE_F16 | number | 是 | 否 | 按键'F16' |
| KEYCODE_F17 | number | 是 | 否 | 按键'F17' | | KEYCODE_F17 | number | 是 | 否 | 按键'F17' |
| KEYCODE_F18 | number | 是 | 否 | 按键'F18' | | KEYCODE_F18 | number | 是 | 否 | 按键'F18' |
| KEYCODE_F19 | number | 是 | 否 | 按键'F19' | | KEYCODE_F19 | number | 是 | 否 | 按键'F19' |
| KEYCODE_F20 | number | 是 | 否 | 按键'F20' | | KEYCODE_F20 | number | 是 | 否 | 按键'F20' |
| KEYCODE_F21 | number | 是 | 否 | 按键'F21' | | KEYCODE_F21 | number | 是 | 否 | 按键'F21' |
| KEYCODE_F22 | number | 是 | 否 | 按键'F22' | | KEYCODE_F22 | number | 是 | 否 | 按键'F22' |
| KEYCODE_F23 | number | 是 | 否 | 按键'F23' | | KEYCODE_F23 | number | 是 | 否 | 按键'F23' |
| KEYCODE_F24 | number | 是 | 否 | 按键'F24' | | KEYCODE_F24 | number | 是 | 否 | 按键'F24' |
| KEYCODE_PROG3 | number | 是 | 否 | 程序键3 | | KEYCODE_PROG3 | number | 是 | 否 | 程序键3 |
| KEYCODE_PROG4 | number | 是 | 否 | 程序键4 | | KEYCODE_PROG4 | number | 是 | 否 | 程序键4 |
| KEYCODE_DASHBOARD | number | 是 | 否 | 仪表板 | | KEYCODE_DASHBOARD | number | 是 | 否 | 仪表板 |
| KEYCODE_SUSPEND | number | 是 | 否 | 挂起键 | | KEYCODE_SUSPEND | number | 是 | 否 | 挂起键 |
| KEYCODE_HP | number | 是 | 否 | 高阶路径键 | | KEYCODE_HP | number | 是 | 否 | 高阶路径键 |
| KEYCODE_SOUND | number | 是 | 否 | 音量键 | | KEYCODE_SOUND | number | 是 | 否 | 音量键 |
| KEYCODE_QUESTION | number | 是 | 否 | 疑问按键 | | KEYCODE_QUESTION | number | 是 | 否 | 疑问按键 |
| KEYCODE_CONNECT | number | 是 | 否 | 连接键 | | KEYCODE_CONNECT | number | 是 | 否 | 连接键 |
| KEYCODE_SPORT | number | 是 | 否 | 运动按键 | | KEYCODE_SPORT | number | 是 | 否 | 运动按键 |
| KEYCODE_SHOP | number | 是 | 否 | 商城键 | | KEYCODE_SHOP | number | 是 | 否 | 商城键 |
| KEYCODE_ALTERASE | number | 是 | 否 | 交替键 | | KEYCODE_ALTERASE | number | 是 | 否 | 交替键 |
| KEYCODE_SWITCHVIDEOMODE | number | 是 | 否 | 在可用视频之间循环输出(监视器/LCD/TV输出/等)| | KEYCODE_SWITCHVIDEOMODE | number | 是 | 否 | 在可用视频之间循环输出(监视器/LCD/TV输出/等) |
| KEYCODE_BATTERY | number | 是 | 否 | 电池按键 | | KEYCODE_BATTERY | number | 是 | 否 | 电池按键 |
| KEYCODE_BLUETOOTH | number | 是 | 否 | 蓝牙按键 | | KEYCODE_BLUETOOTH | number | 是 | 否 | 蓝牙按键 |
| KEYCODE_WLAN | number | 是 | 否 | 无线局域网 | | KEYCODE_WLAN | number | 是 | 否 | 无线局域网 |
| KEYCODE_UWB | number | 是 | 否 | 超宽带(UWB)| | KEYCODE_UWB | number | 是 | 否 | 超宽带(UWB) |
| KEYCODE_WWAN_WIMAX | number | 是 | 否 | WWAN WiMAX按键 | | KEYCODE_WWAN_WIMAX | number | 是 | 否 | WWAN WiMAX按键 |
| KEYCODE_RFKILL | number | 是 | 否 | 控制所有收音机的键 | | KEYCODE_RFKILL | number | 是 | 否 | 控制所有收音机的键 |
| KEYCODE_CHANNEL | number | 是 | 否 | 向上频道键 | | KEYCODE_CHANNEL | number | 是 | 否 | 向上频道键 |
| KEYCODE_BTN_0 | number | 是 | 否 | 按键0 | | KEYCODE_BTN_0 | number | 是 | 否 | 按键0 |
| KEYCODE_BTN_1 | number | 是 | 否 | 按键1 | | KEYCODE_BTN_1 | number | 是 | 否 | 按键1 |
| KEYCODE_BTN_2 | number | 是 | 否 | 按键2 | | KEYCODE_BTN_2 | number | 是 | 否 | 按键2 |
| KEYCODE_BTN_3 | number | 是 | 否 | 按键3 | | KEYCODE_BTN_3 | number | 是 | 否 | 按键3 |
| KEYCODE_BTN_4 | number | 是 | 否 | 按键4 | | KEYCODE_BTN_4 | number | 是 | 否 | 按键4 |
| KEYCODE_BTN_5 | number | 是 | 否 | 按键5 | | KEYCODE_BTN_5 | number | 是 | 否 | 按键5 |
| KEYCODE_BTN_6 | number | 是 | 否 | 按键6 | | KEYCODE_BTN_6 | number | 是 | 否 | 按键6 |
| KEYCODE_BTN_7 | number | 是 | 否 | 按键7 | | KEYCODE_BTN_7 | number | 是 | 否 | 按键7 |
| KEYCODE_BTN_8 | number | 是 | 否 | 按键8 | | KEYCODE_BTN_8 | number | 是 | 否 | 按键8 |
| KEYCODE_BTN_9 | number | 是 | 否 | 按键9 | | KEYCODE_BTN_9 | number | 是 | 否 | 按键9 |
\ No newline at end of file \ No newline at end of file
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
KeyEvent模块提供了设备可以上报的按键事件。 KeyEvent模块提供了设备可以上报的按键事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -13,39 +14,39 @@ import {Action,Key,KeyEvent} from '@ohos.multimodalInput.keyEvent'; ...@@ -13,39 +14,39 @@ import {Action,Key,KeyEvent} from '@ohos.multimodalInput.keyEvent';
## Action ## Action
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | ---- |
| CANCEL | number | 是 | 否 | 取消 | | CANCEL | number | 是 | 否 | 取消 |
| DOWN | number | 是 | 否 | 按下按钮 | | DOWN | number | 是 | 否 | 按下按钮 |
| UP | number | 是 | 否 | 抬起按钮 | | UP | number | 是 | 否 | 抬起按钮 |
## Key ## Key
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------- | ---- | ---- | ------ |
| code | KeyCode | 是 | 否 | 按键码 | | code | KeyCode | 是 | 否 | 按键码 |
| pressedTime | number | 是 | 否 | 按下时间 | | pressedTime | number | 是 | 否 | 按下时间 |
| deviceId | number | 是 | 否 | 按键所属设备 | | deviceId | number | 是 | 否 | 按键所属设备 |
## KeyEvent ## KeyEvent
**系统能力**:以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------- | ---- | ---- | -------------------- |
| action | Action | 是 | 否 | 按键动作 | | action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前发生变化的按键 | | key | Key | 是 | 否 | 当前发生变化的按键 |
| unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 | | unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 |
| keys | Key[] | 是 | 否 | 当前处于按下状态的按键列表 | | keys | Key[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 | | ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 | | altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 | | shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 | | logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 | | fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 | | capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 | | numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 | | scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
\ No newline at end of file \ No newline at end of file
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
提供根据不同媒体类型定义不同的样式。 提供根据不同媒体类型定义不同的样式。
> **说明:** > **说明:**
>
> 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 > 从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
...@@ -118,7 +119,7 @@ off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void ...@@ -118,7 +119,7 @@ off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void
### 示例 ### 示例
```js ```ts
import mediaquery from '@ohos.mediaquery' import mediaquery from '@ohos.mediaquery'
let portraitFunc = null let portraitFunc = null
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
设备上报的鼠标事件。 设备上报的鼠标事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -13,77 +13,77 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou ...@@ -13,77 +13,77 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## Action ## Action
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------ | ---- | ---- | ---------- |
| CANCEL | number | 是 | 否 | 取消 | | CANCEL | number | 是 | 否 | 取消 |
| MOVE | number | 是 | 否 | 鼠标移动 | | MOVE | number | 是 | 否 | 鼠标移动 |
| BUTTON_DOWN | number | 是 | 否 | 鼠标按钮按下 | | BUTTON_DOWN | number | 是 | 否 | 鼠标按钮按下 |
| BUTTON_UP | number | 是 | 否 | 鼠标按钮抬起 | | BUTTON_UP | number | 是 | 否 | 鼠标按钮抬起 |
| AXIS_BEGIN | number | 是 | 否 | 鼠标关联的轴事件开始 | | AXIS_BEGIN | number | 是 | 否 | 鼠标关联的轴事件开始 |
| AXIS_UPDATE | number | 是 | 否 | 鼠标关联的轴事件更新 | | AXIS_UPDATE | number | 是 | 否 | 鼠标关联的轴事件更新 |
| AXIS_END | number | 是 | 否 | 鼠标关联的轴事件结束 | | AXIS_END | number | 是 | 否 | 鼠标关联的轴事件结束 |
## Button ## Button
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ------- | ------ | ---- | ---- | ----- |
| LEFT | number | 是 | 否 | 鼠标左键 | | LEFT | number | 是 | 否 | 鼠标左键 |
| MIDDLE | number | 是 | 否 | 鼠标中键 | | MIDDLE | number | 是 | 否 | 鼠标中键 |
| RIGHT | number | 是 | 否 | 鼠标右键 | | RIGHT | number | 是 | 否 | 鼠标右键 |
| SIDE | number | 是 | 否 | 鼠标侧边键 | | SIDE | number | 是 | 否 | 鼠标侧边键 |
| EXTRA | number | 是 | 否 | 鼠标扩展键 | | EXTRA | number | 是 | 否 | 鼠标扩展键 |
| FORWARD | number | 是 | 否 | 鼠标前进键 | | FORWARD | number | 是 | 否 | 鼠标前进键 |
| BACK | number | 是 | 否 | 鼠标后退键 | | BACK | number | 是 | 否 | 鼠标后退键 |
| TASK | number | 是 | 否 | 鼠标任务键 | | TASK | number | 是 | 否 | 鼠标任务键 |
## Axis ## Axis
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------------- | ------ | ---- | ---- | ----- |
| SCROLL_VERTICAL | number | 是 | 否 | 垂直滚动轴 | | SCROLL_VERTICAL | number | 是 | 否 | 垂直滚动轴 |
| SCROLL_HORIZONTAL | number | 是 | 否 | 水平滚动轴 | | SCROLL_HORIZONTAL | number | 是 | 否 | 水平滚动轴 |
| PINCH | number | 是 | 否 | 捏合轴 | | PINCH | number | 是 | 否 | 捏合轴 |
## AxisValue ## AxisValue
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----- | ------ | ---- | ---- | ---- |
| axis | Axis | 是 | 否 | 轴类型 | | axis | Axis | 是 | 否 | 轴类型 |
| value | number | 是 | 否 | 轴的值 | | value | number | 是 | 否 | 轴的值 |
## MouseEvent ## MouseEvent
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| action | Action | 是 | 否 | 鼠标事件动作 | | action | Action | 是 | 否 | 鼠标事件动作 |
| screenX | number | 是 | 否 | 鼠标光标在屏幕中的x坐标 | | screenX | number | 是 | 否 | 鼠标光标在屏幕中的x坐标 |
| screenY | number | 是 | 否 | 鼠标光标在屏幕中的y坐标 | | screenY | number | 是 | 否 | 鼠标光标在屏幕中的y坐标 |
| windowX | number | 是 | 否 | 鼠标归属窗口的x坐标 | | windowX | number | 是 | 否 | 鼠标归属窗口的x坐标 |
| windowY | number | 是 | 否 | 鼠标归属窗口的y坐标 | | windowY | number | 是 | 否 | 鼠标归属窗口的y坐标 |
| rawDeltaX | number | 是 | 否 | X轴相对上次上报鼠标位置的偏移,在屏幕边缘位置时,该值可能小于两次鼠标上报的坐标差 | | rawDeltaX | number | 是 | 否 | X轴相对上次上报鼠标位置的偏移,在屏幕边缘位置时,该值可能小于两次鼠标上报的坐标差 |
| rawDeltaY | number | 是 | 否 | Y轴相对上次上报鼠标位置的偏移 | | rawDeltaY | number | 是 | 否 | Y轴相对上次上报鼠标位置的偏移 |
| button | Button | 是 | 否 | 当前按下/抬起的按钮 | | button | Button | 是 | 否 | 当前按下/抬起的按钮 |
| pressedButtons | Button[] | 是 | 否 | 当前处于按下状态的按钮 | | pressedButtons | Button[] | 是 | 否 | 当前处于按下状态的按钮 |
| axes | AxisValue[] | 是 | 否 | 事件包含的所有轴数据 | | axes | AxisValue[] | 是 | 否 | 事件包含的所有轴数据 |
| pressedKeys | KeyCode[] | 是 | 否 | 当前处于按下状态的按键列表 | | pressedKeys | KeyCode[] | 是 | 否 | 当前处于按下状态的按键列表 |
| ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 | | ctrlKey | boolean | 是 | 否 | 当前ctrlKey是否处于按下状态 |
| altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 | | altKey | boolean | 是 | 否 | 当前altKey是否处于按下状态 |
| shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 | | shiftKey | boolean | 是 | 否 | 当前shiftKey是否处于按下状态 |
| logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 | | logoKey | boolean | 是 | 否 | 当前logoKey是否处于按下状态 |
| fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 | | fnKey | boolean | 是 | 否 | 当前fnKey是否处于按下状态 |
| capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 | | capsLock | boolean | 是 | 否 | 当前capsLock是否处于激活状态 |
| numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 | | numLock | boolean | 是 | 否 | 当前numLock是否处于激活状态 |
| scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 | | scrollLock | boolean | 是 | 否 | 当前scrollLock是否处于激活状态 |
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
## 导入模块 ## 导入模块
``` ```js
import prompt from '@ohos.prompt' import prompt from '@ohos.prompt'
``` ```
...@@ -26,15 +26,11 @@ showToast(options: ShowToastOptions): void ...@@ -26,15 +26,11 @@ showToast(options: ShowToastOptions): void
| options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 | | options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 |
**示例:** **示例:**
``` ```js
export default { prompt.showToast({
showToast() { message: 'Message Info',
prompt.showToast({ duration: 2000,
message: 'Message Info', });
duration: 2000,
});
}
}
``` ```
## ShowToastOptions ## ShowToastOptions
...@@ -42,11 +38,11 @@ showToast(options: ShowToastOptions): void ...@@ -42,11 +38,11 @@ showToast(options: ShowToastOptions): void
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- | | -------- | ---------------------------------------- | ------ | ---------------------------------------- |
| message | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 显示的文本信息。 | | message | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 显示的文本信息。 |
| duration | number | 否 | 默认值1500ms,建议区间:1500ms-10000ms,若小于1500ms则取默认值。 | | duration | number | 否 | 默认值1500ms,建议区间:1500ms-10000ms,若小于1500ms则取默认值。 |
| bottom | string | number | 否 | 设置弹窗边框距离屏幕底部的位置。 | | bottom | string | number | 否 |
## prompt.showDialog ## prompt.showDialog
...@@ -69,31 +65,27 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt; ...@@ -69,31 +65,27 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;
**示例:** **示例:**
``` ```js
export default { prompt.showDialog({
showDialog() { title: 'Title Info',
prompt.showDialog({ message: 'Message Info',
title: 'Title Info', buttons: [
message: 'Message Info', {
buttons: [ text: 'button1',
{ color: '#000000',
text: 'button1', },
color: '#000000', {
}, text: 'button2',
{ color: '#000000',
text: 'button2',
color: '#000000',
}
],
})
.then(data => {
console.info('showDialog success, click button: ' + data.index);
})
.catch(err => {
console.info('showDialog error: ' + err);
})
} }
} ],
})
.then(data => {
console.info('showDialog success, click button: ' + data.index);
})
.catch(err => {
console.info('showDialog error: ' + err);
})
``` ```
## prompt.showDialog ## prompt.showDialog
...@@ -112,32 +104,27 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc ...@@ -112,32 +104,27 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
| callback | AsyncCallback&lt;[ShowDialogSuccessResponse](#showdialogsuccessresponse)&gt; | 是 | 对话框响应结果回调。 | | callback | AsyncCallback&lt;[ShowDialogSuccessResponse](#showdialogsuccessresponse)&gt; | 是 | 对话框响应结果回调。 |
**示例:** **示例:**
``` ```js
export default { prompt.showDialog({
callback(err, data) { title: 'showDialog Title Info',
if(err) { message: 'Message Info',
console.info('showDialog err: ' + err); buttons: [
return; {
} text: 'button1',
console.info('showDialog success callback, click button: ' + data.index); color: '#000000',
}, },
showDialog() { {
prompt.showDialog({ text: 'button2',
title: 'showDialog Title Info', color: '#000000',
message: 'Message Info',
buttons: [
{
text: 'button1',
color: '#000000',
},
{
text: 'button2',
color: '#000000',
}
]
}, this.callback);
} }
]
}, (err, data) => {
if (err) {
console.info('showDialog err: ' + err);
return;
} }
console.info('showDialog success callback, click button: ' + data.index);
});
``` ```
## ShowDialogOptions ## ShowDialogOptions
...@@ -146,11 +133,11 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc ...@@ -146,11 +133,11 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- | | ------- | ---------------------------------------- | ---- | ---------------------------------------- |
| title | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 标题文本。 | | title | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 标题文本。 |
| message | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 内容文本。 | | message | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 内容文本。 |
| buttons | Array | 否 | 对话框中按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 | | buttons | Array | 否 | 对话框中按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-3个按钮。其中第一个为positiveButton;第二个为negativeButton;第三个为neutralButton。 |
## ShowDialogSuccessResponse ## ShowDialogSuccessResponse
...@@ -179,31 +166,26 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu ...@@ -179,31 +166,26 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
**示例:** **示例:**
``` ```js
export default { prompt.showActionMenu({
callback(err, data) { title: 'Title Info',
if(err) { buttons: [
console.info('showActionMenu err: ' + err); {
return; text: 'item1',
} color: '#666666',
console.info('showActionMenu success callback, click button: ' + data.index);
}, },
showActionMenu() { {
prompt.showActionMenu({ text: 'item2',
title: 'Title Info', color: '#000000',
buttons: [ },
{ ]
text: 'item1', }, (err, data) => {
color: '#666666', if (err) {
}, console.info('showActionMenu err: ' + err);
{ return;
text: 'item2',
color: '#000000',
},
]
}, this.callback)
}
} }
console.info('showActionMenu success callback, click button: ' + data.index);
})
``` ```
## prompt.showActionMenu ## prompt.showActionMenu
...@@ -225,47 +207,43 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse ...@@ -225,47 +207,43 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
| Promise&lt;[ActionMenuSuccessResponse](#actionmenusuccessresponse)&gt; | 菜单响应结果。 | | Promise&lt;[ActionMenuSuccessResponse](#actionmenusuccessresponse)&gt; | 菜单响应结果。 |
**示例:** **示例:**
``` ```js
export default { prompt.showActionMenu({
showActionMenu() { title: 'showActionMenu Title Info',
prompt.showActionMenu({ buttons: [
title: 'showActionMenu Title Info', {
buttons: [ text: 'item1',
{ color: '#666666',
text: 'item1', },
color: '#666666', {
}, text: 'item2',
{ color: '#000000',
text: 'item2', },
color: '#000000', ]
}, })
] .then(data => {
}) console.info('showActionMenu success, click button: ' + data.index);
.then(data => { })
console.info('showActionMenu success, click button: ' + data.index); .catch(err => {
}) console.info('showActionMenu error: ' + err);
.catch(err => { })
console.info('showActionMenu error: ' + err);
})
}
}
``` ```
## ActionMenuOptions ## ActionMenuOptions
操作菜单的选项。 操作菜单的选项。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- | | ------- | ---------------------------------------- | ---- | ---------------------------------------- |
| title | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 标题文本。 | | title | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 否 | 标题文本。 |
| buttons | Array&lt;[Button](#button)&gt; | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 | | buttons | Array&lt;[Button](#button)&gt; | 是 | 菜单中菜单项按钮的数组,结构为:{text:'button',&nbsp;color:&nbsp;'\#666666'},支持1-6个按钮。大于6个按钮时弹窗不显示。 |
## ActionMenuSuccessResponse ## ActionMenuSuccessResponse
操作菜单的响应结果。 操作菜单的响应结果。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------------------ | | ----- | ------ | ---- | ------------------------ |
...@@ -275,10 +253,10 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse ...@@ -275,10 +253,10 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
菜单中的菜单项按钮。 菜单中的菜单项按钮。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。 **系统能力:** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------------------ | | ----- | ---------------------------------------- | ---- | ------- |
| text | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 按钮文本内容。 | | text | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 按钮文本内容。 |
| color | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 按钮文本颜色。 | | color | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 按钮文本颜色。 |
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
## 导入模块 ## 导入模块
``` ```js
import resourceManager from '@ohos.resourceManager'; import resourceManager from '@ohos.resourceManager';
``` ```
...@@ -17,7 +17,7 @@ import resourceManager from '@ohos.resourceManager'; ...@@ -17,7 +17,7 @@ import resourceManager from '@ohos.resourceManager';
从API Version9开始,Stage模型支持了通过context获取resourceManager对象的方式,再调用其内部获取资源的接口,无需再导入包,此方式FA模型不适用。 从API Version9开始,Stage模型支持了通过context获取resourceManager对象的方式,再调用其内部获取资源的接口,无需再导入包,此方式FA模型不适用。
``` ```ts
this.context.resourceManager; this.context.resourceManager;
``` ```
...@@ -37,7 +37,7 @@ getResourceManager(callback: AsyncCallback&lt;ResourceManager&gt;): void ...@@ -37,7 +37,7 @@ getResourceManager(callback: AsyncCallback&lt;ResourceManager&gt;): void
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 | | callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -71,7 +71,7 @@ getResourceManager(bundleName: string, callback: AsyncCallback&lt;ResourceManage ...@@ -71,7 +71,7 @@ getResourceManager(bundleName: string, callback: AsyncCallback&lt;ResourceManage
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 | | callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => { resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
}); });
``` ```
...@@ -93,7 +93,7 @@ getResourceManager(): Promise&lt;ResourceManager&gt; ...@@ -93,7 +93,7 @@ getResourceManager(): Promise&lt;ResourceManager&gt;
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 |
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager().then(mgr => { resourceManager.getResourceManager().then(mgr => {
mgr.getString(0x1000000, (error, value) => { mgr.getString(0x1000000, (error, value) => {
if (error != null) { if (error != null) {
...@@ -129,11 +129,9 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -129,11 +129,9 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 |
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager("com.example.myapplication").then(mgr => { resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
}).catch(error => { }).catch(error => {
}); });
``` ```
...@@ -142,7 +140,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -142,7 +140,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示设备屏幕方向。 用于表示设备屏幕方向。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- | | -------------------- | ---- | ---- |
...@@ -154,7 +152,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -154,7 +152,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示当前设备类型。 用于表示当前设备类型。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- | | -------------------- | ---- | ---- |
...@@ -170,7 +168,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -170,7 +168,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示当前设备屏幕密度。 用于表示当前设备屏幕密度。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------- | ---- | ---------- | | -------------- | ---- | ---------- |
...@@ -186,7 +184,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -186,7 +184,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
表示当前设备的状态。 表示当前设备的状态。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
...@@ -196,7 +194,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -196,7 +194,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => { mgr.getConfiguration((error, value) => {
let direction = value.direction; let direction = value.direction;
...@@ -209,7 +207,7 @@ resourceManager.getResourceManager((error, mgr) => { ...@@ -209,7 +207,7 @@ resourceManager.getResourceManager((error, mgr) => {
表示设备支持的能力。 表示设备支持的能力。
**系统能力**以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
...@@ -219,7 +217,7 @@ resourceManager.getResourceManager((error, mgr) => { ...@@ -219,7 +217,7 @@ resourceManager.getResourceManager((error, mgr) => {
**示例:** **示例:**
``` ```js
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => { mgr.getDeviceCapability((error, value) => {
let screenDensity = value.screenDensity; let screenDensity = value.screenDensity;
...@@ -230,8 +228,9 @@ resourceManager.getResourceManager((error, mgr) => { ...@@ -230,8 +228,9 @@ resourceManager.getResourceManager((error, mgr) => {
## RawFileDescriptor<sup>8+</sup> ## RawFileDescriptor<sup>8+</sup>
表示rawfile的descriptor信息。<br> 表示rawfile的descriptor信息。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力:** SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ | | ------ | ------ | ------------------ |
...@@ -245,11 +244,11 @@ resourceManager.getResourceManager((error, mgr) => { ...@@ -245,11 +244,11 @@ resourceManager.getResourceManager((error, mgr) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager **系统能力:** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ | | ---------- | ------ | ----------- |
| bundleName | string | 应用的bundle名称 | | bundleName | string | 应用的bundle名称 |
| moduleName | string | 应用的module名称 | | moduleName | string | 应用的module名称 |
| id | number | 资源的id值 | | id | number | 资源的id值 |
## ResourceManager ## ResourceManager
...@@ -278,7 +277,7 @@ getString(resId: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -278,7 +277,7 @@ getString(resId: number, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id, (error, value) => { mgr.getString($r('app.string.test').id, (error, value) => {
if (error != null) { if (error != null) {
...@@ -310,7 +309,7 @@ getString(resId: number): Promise&lt;string&gt; ...@@ -310,7 +309,7 @@ getString(resId: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 资源ID值对应的字符串 | | Promise&lt;string&gt; | 资源ID值对应的字符串 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id).then(value => { mgr.getString($r('app.string.test').id).then(value => {
let str = value; let str = value;
...@@ -332,11 +331,11 @@ getString(resource: Resource, callback: AsyncCallback&lt;string&gt;): void ...@@ -332,11 +331,11 @@ getString(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- | | -------- | --------------------------- | ---- | --------------- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -360,17 +359,17 @@ getString(resource: Resource): Promise&lt;string&gt; ...@@ -360,17 +359,17 @@ getString(resource: Resource): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | --------------------- | ---------------- |
| Promise&lt;string&gt; | resource对象对应的字符串 | | Promise&lt;string&gt; | resource对象对应的字符串 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -398,7 +397,7 @@ getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt; ...@@ -398,7 +397,7 @@ getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id, (error, value) => { mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
if (error != null) { if (error != null) {
...@@ -430,7 +429,7 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt; ...@@ -430,7 +429,7 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id).then(value => { mgr.getStringArray($r('app.strarray.test').id).then(value => {
let strArray = value; let strArray = value;
...@@ -449,13 +448,13 @@ getStringArray(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt ...@@ -449,13 +448,13 @@ getStringArray(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -479,17 +478,17 @@ getStringArray(resource: Resource): Promise&lt;Array&lt;string&gt;&gt; ...@@ -479,17 +478,17 @@ getStringArray(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -517,7 +516,7 @@ getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -517,7 +516,7 @@ getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id, (error, value) => { mgr.getMedia($r('app.media.test').id, (error, value) => {
if (error != null) { if (error != null) {
...@@ -549,7 +548,7 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt; ...@@ -549,7 +548,7 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt;
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id).then(value => { mgr.getMedia($r('app.media.test').id).then(value => {
let media = value; let media = value;
...@@ -568,13 +567,13 @@ getMedia(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -568,13 +567,13 @@ getMedia(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- | | -------- | ------------------------------- | ---- | ------------------ |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -598,17 +597,17 @@ getMedia(resource: Resource): Promise&lt;Uint8Array&gt; ...@@ -598,17 +597,17 @@ getMedia(resource: Resource): Promise&lt;Uint8Array&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------------------------- | ------------------- |
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -636,7 +635,7 @@ getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void ...@@ -636,7 +635,7 @@ getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id, (error, value) => { mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
if (error != null) { if (error != null) {
...@@ -668,7 +667,7 @@ getMediaBase64(resId: number): Promise&lt;string&gt; ...@@ -668,7 +667,7 @@ getMediaBase64(resId: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id).then(value => { mgr.getMediaBase64($r('app.media.test').id).then(value => {
let media = value; let media = value;
...@@ -689,11 +688,11 @@ getMediaBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void ...@@ -689,11 +688,11 @@ getMediaBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------ | | -------- | --------------------------- | ---- | ------------------------ |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -717,17 +716,17 @@ getMediaBase64(resource: Resource): Promise&lt;string&gt; ...@@ -717,17 +716,17 @@ getMediaBase64(resource: Resource): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------------- | | --------------------- | ------------------------- |
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 | | Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -755,7 +754,7 @@ getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void ...@@ -755,7 +754,7 @@ getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
| callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是 | 异步回调,用于返回设备的Configuration | | callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是 | 异步回调,用于返回设备的Configuration |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => { mgr.getConfiguration((error, value) => {
if (error != null) { if (error != null) {
...@@ -783,7 +782,7 @@ getConfiguration(): Promise&lt;Configuration&gt; ...@@ -783,7 +782,7 @@ getConfiguration(): Promise&lt;Configuration&gt;
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration | | Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration().then(value => { mgr.getConfiguration().then(value => {
let direction = value.direction; let direction = value.direction;
...@@ -809,7 +808,7 @@ getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void ...@@ -809,7 +808,7 @@ getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
| callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是 | 异步回调,用于返回设备的DeviceCapability | | callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是 | 异步回调,用于返回设备的DeviceCapability |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => { mgr.getDeviceCapability((error, value) => {
if (error != null) { if (error != null) {
...@@ -837,7 +836,7 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt; ...@@ -837,7 +836,7 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt;
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability | | Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability().then(value => { mgr.getDeviceCapability().then(value => {
let screenDensity = value.screenDensity; let screenDensity = value.screenDensity;
...@@ -865,7 +864,7 @@ getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt ...@@ -865,7 +864,7 @@ getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定ID字符串表示的单复数字符串 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => { mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
if (error != null) { if (error != null) {
...@@ -898,7 +897,7 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt; ...@@ -898,7 +897,7 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1).then(value => { mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
let str = value; let str = value;
...@@ -917,14 +916,14 @@ getPluralString(resource: Resource, num: number, callback: AsyncCallback&lt;stri ...@@ -917,14 +916,14 @@ getPluralString(resource: Resource, num: number, callback: AsyncCallback&lt;stri
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- | | -------- | --------------------------- | ---- | ------------------------------------ |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定resource对象表示的单复数字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据指定数量获取指定resource对象表示的单复数字符串 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -948,18 +947,18 @@ getPluralString(resource: Resource, num: number): Promise&lt;string&gt; ...@@ -948,18 +947,18 @@ getPluralString(resource: Resource, num: number): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------- | | --------------------- | ------------------------------ |
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -987,7 +986,7 @@ getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -987,7 +986,7 @@ getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的rawfile文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的rawfile文件内容 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml", (error, value) => { mgr.getRawFile("test.xml", (error, value) => {
if (error != null) { if (error != null) {
...@@ -1018,7 +1017,7 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt; ...@@ -1018,7 +1017,7 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt;
| Promise&lt;Uint8Array&gt; | rawfile文件内容 | | Promise&lt;Uint8Array&gt; | rawfile文件内容 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml").then(value => { mgr.getRawFile("test.xml").then(value => {
let rawFile = value; let rawFile = value;
...@@ -1043,7 +1042,7 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor& ...@@ -1043,7 +1042,7 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor&
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是 | 异步回调,用于返回获取的rawfile文件的descriptor | | callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是 | 异步回调,用于返回获取的rawfile文件的descriptor |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml", (error, value) => { mgr.getRawFileDescriptor("test.xml", (error, value) => {
if (error != null) { if (error != null) {
...@@ -1076,7 +1075,7 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt; ...@@ -1076,7 +1075,7 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt;
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor | | Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml").then(value => { mgr.getRawFileDescriptor("test.xml").then(value => {
let fd = value.fd; let fd = value.fd;
...@@ -1103,7 +1102,7 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -1103,7 +1102,7 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步回调 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml", (error, value) => { mgr.closeRawFileDescriptor("test.xml", (error, value) => {
if (error != null) { if (error != null) {
...@@ -1132,7 +1131,7 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt; ...@@ -1132,7 +1131,7 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt;
| Promise&lt;void&gt; | 无返回值 | | Promise&lt;void&gt; | 无返回值 |
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml").then(value => { mgr.closeRawFileDescriptor("test.xml").then(value => {
let result = value; let result = value;
...@@ -1151,7 +1150,7 @@ release() ...@@ -1151,7 +1150,7 @@ release()
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**示例:** **示例:**
``` ```ts
resourceManager.getResourceManager((error, mgr) => { resourceManager.getResourceManager((error, mgr) => {
mgr.release(); mgr.release();
}); });
...@@ -1168,11 +1167,11 @@ getStringByName(resName: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -1168,11 +1167,11 @@ getStringByName(resName: string, callback: AsyncCallback&lt;string&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- | | -------- | --------------------------- | ---- | --------------- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的字符串 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringByName("test", (error, value) => { this.context.resourceManager.getStringByName("test", (error, value) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -1191,17 +1190,17 @@ getStringByName(resName: string): Promise&lt;string&gt; ...@@ -1191,17 +1190,17 @@ getStringByName(resName: string): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | 资源名称对应的字符串 | | Promise&lt;string&gt; | 资源名称对应的字符串 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringByName("test").then(value => { this.context.resourceManager.getStringByName("test").then(value => {
let string = value; let string = value;
}).catch(error => { }).catch(error => {
...@@ -1220,11 +1219,11 @@ getStringArrayByName(resName: string, callback: AsyncCallback&lt;Array&lt;string ...@@ -1220,11 +1219,11 @@ getStringArrayByName(resName: string, callback: AsyncCallback&lt;Array&lt;string
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------- | | -------- | ---------------------------------------- | ---- | ----------------- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调,用于返回获取的字符串数组 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringArrayByName("test", (error, value) => { this.context.resourceManager.getStringArrayByName("test", (error, value) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -1243,17 +1242,17 @@ getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1243,17 +1242,17 @@ getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------- | | ---------------------------------- | ------------ |
| Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringArrayByName("test").then(value => { this.context.resourceManager.getStringArrayByName("test").then(value => {
let strArray = value; let strArray = value;
}).catch(error => { }).catch(error => {
...@@ -1272,11 +1271,11 @@ getMediaByName(resName: string, callback: AsyncCallback&lt;Uint8Array&gt;): void ...@@ -1272,11 +1271,11 @@ getMediaByName(resName: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ------------------ | | -------- | ------------------------------- | ---- | ------------------ |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 | | callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调,用于返回获取的媒体文件内容 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getMediaByName("test", (error, value) => { this.context.resourceManager.getMediaByName("test", (error, value) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -1295,17 +1294,17 @@ getMediaByName(resName: string): Promise&lt;Uint8Array&gt; ...@@ -1295,17 +1294,17 @@ getMediaByName(resName: string): Promise&lt;Uint8Array&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | -------------- | | ------------------------- | ------------- |
| Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getMediaByName("test").then(value => { this.context.resourceManager.getMediaByName("test").then(value => {
let media = value; let media = value;
}).catch(error => { }).catch(error => {
...@@ -1324,11 +1323,11 @@ getMediaBase64ByName(resName: string, callback: AsyncCallback&lt;string&gt;): vo ...@@ -1324,11 +1323,11 @@ getMediaBase64ByName(resName: string, callback: AsyncCallback&lt;string&gt;): vo
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------ | | -------- | --------------------------- | ---- | ------------------------ |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,用于返回获取的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getMediaBase64ByName("test", (error, value) => { this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -1347,17 +1346,17 @@ getMediaBase64ByName(resName: string): Promise&lt;string&gt; ...@@ -1347,17 +1346,17 @@ getMediaBase64ByName(resName: string): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------------- | | --------------------- | ------------------- |
| Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getMediaBase64ByName("test").then(value => { this.context.resourceManager.getMediaBase64ByName("test").then(value => {
let media = value; let media = value;
}).catch(error => { }).catch(error => {
...@@ -1374,14 +1373,14 @@ getPluralStringByName(resName: string, num: number, callback: AsyncCallback&lt;s ...@@ -1374,14 +1373,14 @@ getPluralStringByName(resName: string, num: number, callback: AsyncCallback&lt;s
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- | | -------- | --------------------------- | ---- | ----------------------------- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据传入的数量值获取资源名称对应的字符串资源 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步回调,返回根据传入的数量值获取资源名称对应的字符串资源 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => { this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => {
if (error != null) { if (error != null) {
console.log("error is " + error); console.log("error is " + error);
...@@ -1400,18 +1399,18 @@ getPluralStringByName(resName: string, num: number): Promise&lt;string&gt; ...@@ -1400,18 +1399,18 @@ getPluralStringByName(resName: string, num: number): Promise&lt;string&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------- | | --------------------- | ---------------------- |
| Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 | | Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getPluralStringByName("test", 1).then(value => { this.context.resourceManager.getPluralStringByName("test", 1).then(value => {
let str = value; let str = value;
}).catch(error => { }).catch(error => {
...@@ -1433,12 +1432,12 @@ getStringSync(resId: number): string ...@@ -1433,12 +1432,12 @@ getStringSync(resId: number): string
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | ----------- |
| string | 资源ID值对应的字符串 | | string | 资源ID值对应的字符串 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringSync($r('app.string.test').id); this.context.resourceManager.getStringSync($r('app.string.test').id);
``` ```
...@@ -1451,17 +1450,17 @@ getStringSync(resource: Resource): string ...@@ -1451,17 +1450,17 @@ getStringSync(resource: Resource): string
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | ---------------- |
| string | resource对象对应的字符串 | | string | resource对象对应的字符串 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -1479,17 +1478,17 @@ getStringByNameSync(resName: string): string ...@@ -1479,17 +1478,17 @@ getStringByNameSync(resName: string): string
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | ---------- |
| string | 资源名称对应的字符串 | | string | 资源名称对应的字符串 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getStringByNameSync("test"); this.context.resourceManager.getStringByNameSync("test");
``` ```
...@@ -1507,12 +1506,12 @@ getBoolean(resId: number): boolean ...@@ -1507,12 +1506,12 @@ getBoolean(resId: number): boolean
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------- | ------------ |
| boolean | 资源ID值对应的布尔结果 | | boolean | 资源ID值对应的布尔结果 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id); this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
``` ```
### getBoolean<sup>9+</sup> ### getBoolean<sup>9+</sup>
...@@ -1524,17 +1523,17 @@ getBoolean(resource: Resource): boolean ...@@ -1524,17 +1523,17 @@ getBoolean(resource: Resource): boolean
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------- | ----------------- |
| boolean | resource对象对应的布尔结果 | | boolean | resource对象对应的布尔结果 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -1552,17 +1551,17 @@ getBooleanByName(resName: string): boolean ...@@ -1552,17 +1551,17 @@ getBooleanByName(resName: string): boolean
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------- | ----------- |
| boolean | 资源名称对应的布尔结果 | | boolean | 资源名称对应的布尔结果 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getBooleanByName("boolean_test"); this.context.resourceManager.getBooleanByName("boolean_test");
``` ```
...@@ -1580,12 +1579,12 @@ getNumber(resId: number): number ...@@ -1580,12 +1579,12 @@ getNumber(resId: number): number
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | ---------- |
| number | 资源ID值对应的数值 | | number | 资源ID值对应的数值 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getNumber($r('app.integer.integer_test').id); this.context.resourceManager.getNumber($r('app.integer.integer_test').id);
this.context.resourceManager.getNumber($r('app.float.float_test').id); this.context.resourceManager.getNumber($r('app.float.float_test').id);
``` ```
...@@ -1599,17 +1598,17 @@ getNumber(resource: Resource): number ...@@ -1599,17 +1598,17 @@ getNumber(resource: Resource): number
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | --------------- |
| number | resource对象对应的数值 | | number | resource对象对应的数值 |
**示例:** **示例:**
``` ```ts
let resource = { let resource = {
bundleName: "com.example.myapplication", bundleName: "com.example.myapplication",
moduleName: "entry", moduleName: "entry",
...@@ -1627,17 +1626,17 @@ getNumberByName(resName: string): number ...@@ -1627,17 +1626,17 @@ getNumberByName(resName: string): number
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- | | ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | ------ | --------- |
| number | 资源名称对应的数值 | | number | 资源名称对应的数值 |
**示例:** **示例:**
``` ```ts
this.context.resourceManager.getNumberByName("integer_test"); this.context.resourceManager.getNumberByName("integer_test");
this.context.resourceManager.getNumberByName("float_test"); this.context.resourceManager.getNumberByName("float_test");
``` ```
\ No newline at end of file
...@@ -2,7 +2,8 @@ ...@@ -2,7 +2,8 @@
设备上报的触屏事件。 设备上报的触屏事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -13,72 +14,72 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput ...@@ -13,72 +14,72 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## Action ## Action
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ------ | ------ | ---- | ---- | ---- |
| CANCEL | number | 是 | 否 | 触摸取消 | | CANCEL | number | 是 | 否 | 触摸取消 |
| DOWN | number | 是 | 否 | 触摸按下 | | DOWN | number | 是 | 否 | 触摸按下 |
| MOVE | number | 是 | 否 | 触摸移动 | | MOVE | number | 是 | 否 | 触摸移动 |
| UP | number | 是 | 否 | 触摸抬起 | | UP | number | 是 | 否 | 触摸抬起 |
## ToolType ## ToolType
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | -------- | ------ | ---- | ---- | ---- |
| FINGER | number | 是 | 否 | 手指 | | FINGER | number | 是 | 否 | 手指 |
| PEN | number | 是 | 否 | 笔 | | PEN | number | 是 | 否 | 笔 |
| RUBBER | number | 是 | 否 | 橡皮擦 | | RUBBER | number | 是 | 否 | 橡皮擦 |
| BRUSH | number | 是 | 否 | 笔刷 | | BRUSH | number | 是 | 否 | 笔刷 |
| PENCIL | number | 是 | 否 | 铅笔 | | PENCIL | number | 是 | 否 | 铅笔 |
| AIRBRUSH | number | 是 | 否 | 气笔 | | AIRBRUSH | number | 是 | 否 | 气笔 |
| MOUSE | number | 是 | 否 | 鼠标 | | MOUSE | number | 是 | 否 | 鼠标 |
| LENS | number | 是 | 否 | 透镜 | | LENS | number | 是 | 否 | 透镜 |
## SourceType ## SourceType
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ------------ | ------ | ---- | ---- | ---- |
| TOUCH_SCREEN | number | 是 | 否 | 触摸屏 | | TOUCH_SCREEN | number | 是 | 否 | 触摸屏 |
| PEN | number | 是 | 否 | 手写笔 | | PEN | number | 是 | 否 | 手写笔 |
| TOUCH_PAD | number | 是 | 否 | 触摸板 | | TOUCH_PAD | number | 是 | 否 | 触摸板 |
## Touch ## Touch
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ----------- | ------ | ---- | ---- | ----------------------------------- |
| id | number | 是 | 否 | 指针标识 | | id | number | 是 | 否 | 指针标识 |
| pressedTime | number | 是 | 否 | 按下时的时间戳 | | pressedTime | number | 是 | 否 | 按下时的时间戳 |
| screenX | number | 是 | 否 | 触摸位置所属的屏幕x坐标 | | screenX | number | 是 | 否 | 触摸位置所属的屏幕x坐标 |
| screenY | number | 是 | 否 | 触摸位置所属的屏幕y坐标 | | screenY | number | 是 | 否 | 触摸位置所属的屏幕y坐标 |
| windowX | number | 是 | 否 | 触摸位置在窗口中的x坐标 | | windowX | number | 是 | 否 | 触摸位置在窗口中的x坐标 |
| windowY | number | 是 | 否 | 触摸位置在窗口中的y坐标 | | windowY | number | 是 | 否 | 触摸位置在窗口中的y坐标 |
| pressure | number | 是 | 否 | 压力值,取值范围是[0.0, 1.0], 0.0表示不支持 | | pressure | number | 是 | 否 | 压力值,取值范围是[0.0, 1.0], 0.0表示不支持 |
| width | number | 是 | 否 | 按下接触区域的宽度 | | width | number | 是 | 否 | 按下接触区域的宽度 |
| height | number | 是 | 否 | 按下接触区域的高度 | | height | number | 是 | 否 | 按下接触区域的高度 |
| tiltX | number | 是 | 否 | 相对YZ平面的角度,取值的范围[-90, 90],其中正值是向右倾斜。 | | tiltX | number | 是 | 否 | 相对YZ平面的角度,取值的范围[-90, 90],其中正值是向右倾斜。 |
| tiltY | number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90],其中正值是向下倾斜。 | | tiltY | number | 是 | 否 | 相对XZ平面的角度,值的范围[-90, 90],其中正值是向下倾斜。 |
| toolX | number | 是 | 否 | 工具区域的中心点X | | toolX | number | 是 | 否 | 工具区域的中心点X |
| toolY | number | 是 | 否 | 工具区域的中心点Y | | toolY | number | 是 | 否 | 工具区域的中心点Y |
| toolWidth | number | 是 | 否 | 工具区域宽度 | | toolWidth | number | 是 | 否 | 工具区域宽度 |
| toolHeight | number | 是 | 否 | 工具区域高度 | | toolHeight | number | 是 | 否 | 工具区域高度 |
| rawX | number | 是 | 否 | 输入设备上的x坐标 | | rawX | number | 是 | 否 | 输入设备上的x坐标 |
| rawY | number | 是 | 否 | 输入设备上的y坐标 | | rawY | number | 是 | 否 | 输入设备上的y坐标 |
| toolType | number | 是 | 否 | 工具类型 | | toolType | number | 是 | 否 | 工具类型 |
## TouchEvent ## TouchEvent
**系统能力**以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core **系统能力**:SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 | | 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- | | ---------- | ---------- | ---- | ---- | --------- |
| action | Action | 是 | 否 | 触摸动作 | | action | Action | 是 | 否 | 触摸动作 |
| touch | Touch | 是 | 否 | 当前触摸点 | | touch | Touch | 是 | 否 | 当前触摸点 |
| touches | Touch[] | 是 | 否 | 所有触摸点 | | touches | Touch[] | 是 | 否 | 所有触摸点 |
| sourceType | SourceType | 是 | 否 | 触摸来源的设备类型 | | sourceType | SourceType | 是 | 否 | 触摸来源的设备类型 |
...@@ -41,7 +41,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater ...@@ -41,7 +41,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
**示例:** **示例:**
``` ```ts
try { try {
var upgradeInfo = { var upgradeInfo = {
upgradeApp: "com.ohos.ota.updateclient", upgradeApp: "com.ohos.ota.updateclient",
...@@ -73,7 +73,7 @@ getRestorer(): Restorer ...@@ -73,7 +73,7 @@ getRestorer(): Restorer
**示例:** **示例:**
``` ```ts
try { try {
let restorer = update.getRestorer(); let restorer = update.getRestorer();
} catch(error) { } catch(error) {
...@@ -97,7 +97,7 @@ getLocalUpdater(): LocalUpdater ...@@ -97,7 +97,7 @@ getLocalUpdater(): LocalUpdater
**示例:** **示例:**
``` ```ts
try { try {
let localUpdater = update.getLocalUpdater(); let localUpdater = update.getLocalUpdater();
} catch(error) { } catch(error) {
...@@ -125,7 +125,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void ...@@ -125,7 +125,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void
**示例:** **示例:**
``` ```ts
updater.checkNewVersion((err, result) => { updater.checkNewVersion((err, result) => {
console.log(`checkNewVersion isExistNewVersion ${result?.isExistNewVersion}`); console.log(`checkNewVersion isExistNewVersion ${result?.isExistNewVersion}`);
}); });
...@@ -149,7 +149,7 @@ checkNewVersion(): Promise\<CheckResult> ...@@ -149,7 +149,7 @@ checkNewVersion(): Promise\<CheckResult>
**示例:** **示例:**
``` ```ts
updater.checkNewVersion().then(result => { updater.checkNewVersion().then(result => {
console.log(`checkNewVersion isExistNewVersion: ${result.isExistNewVersion}`); console.log(`checkNewVersion isExistNewVersion: ${result.isExistNewVersion}`);
// 版本摘要信息 // 版本摘要信息
...@@ -177,7 +177,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void ...@@ -177,7 +177,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**示例:** **示例:**
``` ```ts
updater.getNewVersionInfo((err, info) => { updater.getNewVersionInfo((err, info) => {
console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`); console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`); console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`);
...@@ -202,7 +202,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo> ...@@ -202,7 +202,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**示例:** **示例:**
``` ```ts
updater.getNewVersionInfo().then(info => { updater.getNewVersionInfo().then(info => {
console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`); console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`); console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`);
...@@ -231,7 +231,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption ...@@ -231,7 +231,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -274,7 +274,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption ...@@ -274,7 +274,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -311,7 +311,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void ...@@ -311,7 +311,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
**示例:** **示例:**
``` ```ts
updater.getCurrentVersionInfo((err, info) => { updater.getCurrentVersionInfo((err, info) => {
console.log(`info osVersion = ${info?.osVersion}`); console.log(`info osVersion = ${info?.osVersion}`);
console.log(`info deviceName = ${info?.deviceName}`); console.log(`info deviceName = ${info?.deviceName}`);
...@@ -337,7 +337,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo> ...@@ -337,7 +337,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
**示例:** **示例:**
``` ```ts
updater.getCurrentVersionInfo().then(info => { updater.getCurrentVersionInfo().then(info => {
console.log(`info osVersion = ${info.osVersion}`); console.log(`info osVersion = ${info.osVersion}`);
console.log(`info deviceName = ${info.deviceName}`); console.log(`info deviceName = ${info.deviceName}`);
...@@ -366,7 +366,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A ...@@ -366,7 +366,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A
**示例:** **示例:**
``` ```ts
// 描述文件选项 // 描述文件选项
var descriptionOptions = { var descriptionOptions = {
format: DescriptionFormat.STANDARD, // 标准格式 format: DescriptionFormat.STANDARD, // 标准格式
...@@ -403,7 +403,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A ...@@ -403,7 +403,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A
**示例:** **示例:**
``` ```ts
// 描述文件选项 // 描述文件选项
var descriptionOptions = { var descriptionOptions = {
format: DescriptionFormat.STANDARD, // 标准格式 format: DescriptionFormat.STANDARD, // 标准格式
...@@ -435,7 +435,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void ...@@ -435,7 +435,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
**示例:** **示例:**
``` ```ts
updater.getTaskInfo((err, info) => { updater.getTaskInfo((err, info) => {
console.log(`getTaskInfo isexistTask= ${info?.existTask}`); console.log(`getTaskInfo isexistTask= ${info?.existTask}`);
}); });
...@@ -459,7 +459,7 @@ getTaskInfo(): Promise\<TaskInfo> ...@@ -459,7 +459,7 @@ getTaskInfo(): Promise\<TaskInfo>
**示例:** **示例:**
``` ```ts
updater.getTaskInfo().then(info => { updater.getTaskInfo().then(info => {
console.log(`getTaskInfo isexistTask= ${info.existTask}`); console.log(`getTaskInfo isexistTask= ${info.existTask}`);
}).catch(err => { }).catch(err => {
...@@ -487,7 +487,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions, ...@@ -487,7 +487,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions,
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -528,7 +528,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions) ...@@ -528,7 +528,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions)
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -566,7 +566,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu ...@@ -566,7 +566,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -606,7 +606,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu ...@@ -606,7 +606,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -643,7 +643,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD ...@@ -643,7 +643,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -683,7 +683,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD ...@@ -683,7 +683,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -720,7 +720,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca ...@@ -720,7 +720,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -760,7 +760,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P ...@@ -760,7 +760,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -797,7 +797,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal ...@@ -797,7 +797,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -837,7 +837,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr ...@@ -837,7 +837,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr
**示例:** **示例:**
``` ```ts
// 版本摘要信息 // 版本摘要信息
var versionDigestInfo = { var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息 versionDigest: "versionDigest" // 检测结果中的版本摘要信息
...@@ -872,7 +872,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void ...@@ -872,7 +872,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
**示例:** **示例:**
``` ```ts
updater.getUpgradePolicy((err, policy) => { updater.getUpgradePolicy((err, policy) => {
console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`); console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`);
console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`); console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`);
...@@ -897,7 +897,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy> ...@@ -897,7 +897,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy>
**示例:** **示例:**
``` ```ts
updater.getUpgradePolicy().then(policy => { updater.getUpgradePolicy().then(policy => {
console.log(`policy downloadStrategy = ${policy.downloadStrategy}`); console.log(`policy downloadStrategy = ${policy.downloadStrategy}`);
console.log(`policy autoUpgradeStrategy = ${policy.autoUpgradeStrategy}`); console.log(`policy autoUpgradeStrategy = ${policy.autoUpgradeStrategy}`);
...@@ -925,7 +925,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void ...@@ -925,7 +925,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
**示例:** **示例:**
``` ```ts
let policy = { let policy = {
downloadStrategy: false, downloadStrategy: false,
autoUpgradeStrategy: false, autoUpgradeStrategy: false,
...@@ -960,7 +960,7 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void> ...@@ -960,7 +960,7 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
**示例:** **示例:**
``` ```ts
let policy = { let policy = {
downloadStrategy: false, downloadStrategy: false,
autoUpgradeStrategy: false, autoUpgradeStrategy: false,
...@@ -991,7 +991,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void ...@@ -991,7 +991,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void
**示例:** **示例:**
``` ```ts
updater.terminateUpgrade((err) => { updater.terminateUpgrade((err) => {
console.log(`terminateUpgrade error ${JSON.stringify(err)}`); console.log(`terminateUpgrade error ${JSON.stringify(err)}`);
}); });
...@@ -1015,7 +1015,7 @@ terminateUpgrade(): Promise\<void> ...@@ -1015,7 +1015,7 @@ terminateUpgrade(): Promise\<void>
**示例:** **示例:**
``` ```ts
updater.terminateUpgrade().then(() => { updater.terminateUpgrade().then(() => {
console.log(`terminateUpgrade success`); console.log(`terminateUpgrade success`);
}).catch(err => { }).catch(err => {
...@@ -1040,7 +1040,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi ...@@ -1040,7 +1040,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**示例:** **示例:**
``` ```ts
var eventClassifyInfo = { var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: "" extraInfo: ""
...@@ -1067,7 +1067,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v ...@@ -1067,7 +1067,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**示例:** **示例:**
``` ```ts
var eventClassifyInfo = { var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: "" extraInfo: ""
...@@ -1098,7 +1098,7 @@ factoryReset(callback: AsyncCallback\<void>): void ...@@ -1098,7 +1098,7 @@ factoryReset(callback: AsyncCallback\<void>): void
**示例:** **示例:**
``` ```ts
restorer.factoryReset((err) => { restorer.factoryReset((err) => {
console.log(`factoryReset error ${JSON.stringify(err)}`); console.log(`factoryReset error ${JSON.stringify(err)}`);
}); });
...@@ -1122,7 +1122,7 @@ factoryReset(): Promise\<void> ...@@ -1122,7 +1122,7 @@ factoryReset(): Promise\<void>
**示例:** **示例:**
``` ```ts
restorer.factoryReset().then(() => { restorer.factoryReset().then(() => {
console.log(`factoryReset success`); console.log(`factoryReset success`);
}).catch(err => { }).catch(err => {
...@@ -1152,7 +1152,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn ...@@ -1152,7 +1152,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn
**示例:** **示例:**
``` ```ts
var upgradeFile = { var upgradeFile = {
fileType: update.ComponentType.OTA, // OTA包 fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径 filePath: "path" // 本地升级包路径
...@@ -1188,7 +1188,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void ...@@ -1188,7 +1188,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void
**示例:** **示例:**
``` ```ts
var upgradeFile = { var upgradeFile = {
fileType: update.ComponentType.OTA, // OTA包 fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径 filePath: "path" // 本地升级包路径
...@@ -1218,7 +1218,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn ...@@ -1218,7 +1218,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn
**示例:** **示例:**
``` ```ts
var upgradeFiles = [{ var upgradeFiles = [{
fileType: update.ComponentType.OTA, // OTA包 fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径 filePath: "path" // 本地升级包路径
...@@ -1247,7 +1247,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void ...@@ -1247,7 +1247,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void
**示例:** **示例:**
``` ```ts
var upgradeFiles = [{ var upgradeFiles = [{
fileType: update.ComponentType.OTA, // OTA包 fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径 filePath: "path" // 本地升级包路径
...@@ -1275,7 +1275,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi ...@@ -1275,7 +1275,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**示例:** **示例:**
``` ```ts
var eventClassifyInfo = { var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: "" extraInfo: ""
...@@ -1304,7 +1304,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v ...@@ -1304,7 +1304,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**示例:** **示例:**
``` ```ts
var eventClassifyInfo = { var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件 eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: "" extraInfo: ""
......
...@@ -4,13 +4,13 @@ ...@@ -4,13 +4,13 @@
开发者在开发应用时,通过调用延迟任务注册接口,注册对实时性要求不高的延迟任务,该任务默认由系统安排,在系统空闲时根据性能、功耗、热等情况进行调度执行。 开发者在开发应用时,通过调用延迟任务注册接口,注册对实时性要求不高的延迟任务,该任务默认由系统安排,在系统空闲时根据性能、功耗、热等情况进行调度执行。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
``` ```js
import workScheduler from '@ohos.workScheduler' import workScheduler from '@ohos.workScheduler'
``` ```
...@@ -35,7 +35,7 @@ startWork(work: WorkInfo): boolean ...@@ -35,7 +35,7 @@ startWork(work: WorkInfo): boolean
**示例** **示例**
``` ```js
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
...@@ -71,7 +71,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean ...@@ -71,7 +71,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**示例** **示例**
``` ```js
let workInfo = { let workInfo = {
workId: 1, workId: 1,
batteryLevel:50, batteryLevel:50,
...@@ -101,7 +101,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void ...@@ -101,7 +101,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**示例** **示例**
``` ```js
workScheduler.getWorkStatus(50, (err, res) => { workScheduler.getWorkStatus(50, (err, res) => {
if (err) { if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code); console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
...@@ -134,7 +134,7 @@ getWorkStatus(workId: number): Promise\<WorkInfo> ...@@ -134,7 +134,7 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
**示例** **示例**
``` ```js
workScheduler.getWorkStatus(50).then((res) => { workScheduler.getWorkStatus(50).then((res) => {
for (let item in res) { for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
...@@ -165,7 +165,7 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo> ...@@ -165,7 +165,7 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**示例** **示例**
``` ```js
workScheduler.obtainAllWorks((err, res) =>{ workScheduler.obtainAllWorks((err, res) =>{
if (err) { if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code); console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
...@@ -190,7 +190,7 @@ obtainAllWorks(): Promise<Array\<WorkInfo>> ...@@ -190,7 +190,7 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**示例** **示例**
``` ```js
workScheduler.obtainAllWorks().then((res) => { workScheduler.obtainAllWorks().then((res) => {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}).catch((err) => { }).catch((err) => {
...@@ -207,7 +207,7 @@ stopAndClearWorks(): boolean ...@@ -207,7 +207,7 @@ stopAndClearWorks(): boolean
**示例** **示例**
``` ```js
let res = workScheduler.stopAndClearWorks(); let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res); console.info("workschedulerLog res:" + res);
``` ```
...@@ -234,7 +234,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean ...@@ -234,7 +234,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**示例** **示例**
``` ```js
workScheduler.isLastWorkTimeOut(500, (err, res) =>{ workScheduler.isLastWorkTimeOut(500, (err, res) =>{
if (err) { if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code); console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
...@@ -265,7 +265,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -265,7 +265,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**示例** **示例**
``` ```js
workScheduler.isLastWorkTimeOut(500) workScheduler.isLastWorkTimeOut(500)
.then(res => { .then(res => {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
...@@ -278,30 +278,30 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -278,30 +278,30 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## WorkInfo ## WorkInfo
提供工作的具体信息。 提供工作的具体信息。
**系统能力**以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------------- | --------------------------------- | ---- | -------------------------------- | | --------------- | --------------------------------- | ---- | ---------------- |
| workId | number | 是 | 当前工作的ID | | workId | number | 是 | 当前工作的ID |
| bundleName | string | 是 | 延迟任务包名 | | bundleName | string | 是 | 延迟任务包名 |
| abilityName | string | 是 | 延迟任务回调通知的组件名(必填) | | abilityName | string | 是 | 延迟任务回调通知的组件名(必填) |
| networkType | [NetworkType](#networktype) | 否 | 网络类型 | | networkType | [NetworkType](#networktype) | 否 | 网络类型 |
| isCharging | boolean | 否 | 是否充电 | | isCharging | boolean | 否 | 是否充电 |
| chargerType | [ChargingType](#chargingtype) | 否 | 充电类型 | | chargerType | [ChargingType](#chargingtype) | 否 | 充电类型 |
| batteryLevel | number | 否 | 电量 | | batteryLevel | number | 否 | 电量 |
| batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态 | | batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态 |
| storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态 | | storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态 |
| isRepeat | boolean | 否 | 是否循环任务 | | isRepeat | boolean | 否 | 是否循环任务 |
| repeatCycleTime | number | 否 | 循环间隔 | | repeatCycleTime | number | 否 | 循环间隔 |
| repeatCount | number | 否 | 循环次数 | | repeatCount | number | 否 | 循环次数 |
| isPersisted | boolean | 否 | 是否持久化保存工作 | | isPersisted | boolean | 否 | 是否持久化保存工作 |
| isDeepIdle | boolean | 否 | 是否要求设备进入空闲状态 | | isDeepIdle | boolean | 否 | 是否要求设备进入空闲状态 |
| idleWaitTime | number | 否 | 空闲等待时间 | | idleWaitTime | number | 否 | 空闲等待时间 |
## NetworkType ## NetworkType
触发工作的网络类型。 触发工作的网络类型。
**系统能力**以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ---------------------- | ---- | ----------------------- | | ---------------------- | ---- | ----------------------- |
...@@ -315,7 +315,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -315,7 +315,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## ChargingType ## ChargingType
触发工作的充电类型。 触发工作的充电类型。
**系统能力**以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ------------------------- | ---- | -------------------- | | ------------------------- | ---- | -------------------- |
...@@ -327,7 +327,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -327,7 +327,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## BatteryStatus ## BatteryStatus
触发工作的电池状态。 触发工作的电池状态。
**系统能力**以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------------------------- | ---- | -------------------------- | | -------------------------- | ---- | -------------------------- |
...@@ -338,10 +338,10 @@ isLastWorkTimeOut(workId: number): Promise\<boolean> ...@@ -338,10 +338,10 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## StorageRequest ## StorageRequest
触发工作的存储状态。 触发工作的存储状态。
**系统能力**以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler **系统能力**:SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明| | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | ------------------------- | ---- | ------------------------------ |
|STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。 | STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 |
|STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。 | STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 |
|STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 | STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file \ No newline at end of file
# UI开发 # UI开发
- [方舟开发框架(ArkUI)概述](arkui-overview.md) - [方舟开发框架(ArkUI)概述](arkui-overview.md)
- 基于JS扩展的类Web开发范式
- [概述](ui-js-overview.md)
- 框架说明
- [文件组织](js-framework-file.md)
- [js标签配置](js-framework-js-tag.md)
- [app.js](js-framework-js-file.md)
- 语法
- [HML语法参考](js-framework-syntax-hml.md)
- [CSS语法参考](js-framework-syntax-css.md)
- [JS语法参考](js-framework-syntax-js.md)
- [生命周期](js-framework-lifecycle.md)
- [资源限定与访问](js-framework-resource-restriction.md)
- [多语言支持](js-framework-multiple-languages.md)
- 构建用户界面
- [组件介绍](ui-js-building-ui-component.md)
- 构建布局
- [布局说明](ui-js-building-ui-layout-intro.md)
- [添加标题行和文本区域](ui-js-building-ui-layout-text.md)
- [添加图片区域](ui-js-building-ui-layout-image.md)
- [添加留言区域](ui-js-building-ui-layout-comment.md)
- [添加容器](ui-js-building-ui-layout-external-container.md)
- [添加交互](ui-js-building-ui-interactions.md)
- [动画](ui-js-building-ui-animation.md)
- [手势事件](ui-js-building-ui-event.md)
- [页面路由](ui-js-building-ui-routes.md)
- 常见组件开发指导
- 容器组件
- [List开发指导](ui-js-components-list.md)
- [Dialog开发指导](ui-js-components-dialog.md)
- [Form开发指导](ui-js-components-form.md)
- [Stepper开发指导](ui-js-components-stepper.md)
- [Tabs开发指导](ui-js-component-tabs.md)
- [Swiper开发指导](ui-js-components-swiper.md)
- 基础组件
- [Text开发指导](ui-js-components-text.md)
- [Input开发指导](ui-js-components-input.md)
- [Button开发指导](ui-js-components-button.md)
- [Picker开发指导](ui-js-components-picker.md)
- [Image开发指导](ui-js-components-images.md)
- [Image-animator开发指导](ui-js-components-image-animator.md)
- [Rating开发指导](ui-js-components-rating.md)
- [Slider开发指导](ui-js-components-slider.md)
- [Chart开发指导](ui-js-components-chart.md)
- [Switch开发指导](ui-js-components-switch.md)
- [Toolbar开发指导](ui-js-components-toolbar.md)
- [Menu开发指导](ui-js-components-menu.md)
- [Marquee开发指导](ui-js-components-marquee.md)
- [Qrcode开发指导](ui-js-components-qrcode.md)
- [Search开发指导](ui-js-components-search.md)
- Canvas开发指导
- [Canvas对象](ui-js-components-canvas.md)
- [CanvasRenderingContext2D对象](ui-js-components-canvasrenderingcontext2d.md)
- [Path2D对象](ui-js-components-path2d.md)
- [OffscreenCanvas对象](ui-js-components-offscreencanvas.md)
- [栅格布局](ui-js-components-grid.md)
- Svg开发指导
- [基础知识](ui-js-components-svg-overview.md)
- [绘制图形](ui-js-components-svg-graphics.md)
- [绘制路径](ui-js-components-svg-path.md)
- [绘制文本](ui-js-components-svg-text.md)
- 动效开发指导
- CSS动画
- [属性样式动画](ui-js-animate-attribute-style.md)
- [transform样式动画](ui-js-animate-transform.md)
- [background-position样式动画](ui-js-animate-background-position-style.md)
- [svg动画](ui-js-animate-svg.md)
- JS动画
- [组件动画](ui-js-animate-component.md)
- 插值器动画
- [动画动效](ui-js-animate-dynamic-effects.md)
- [动画帧](ui-js-animate-frame.md)
- [自定义组件](ui-js-custom-components.md)
- 基于TS扩展的声明式开发范式 - 基于TS扩展的声明式开发范式
- [概述](ui-ts-overview.md) - [概述](ui-ts-overview.md)
- 框架说明 - 框架说明
...@@ -144,3 +72,76 @@ ...@@ -144,3 +72,76 @@
- [构建食物列表List布局](ui-ts-building-category-list-layout.md) - [构建食物列表List布局](ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui-ts-building-category-grid-layout.md) - [构建食物分类Grid布局](ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui-ts-page-redirection-data-transmission.md) - [页面跳转与数据传递](ui-ts-page-redirection-data-transmission.md)
- 基于JS扩展的类Web开发范式
- [概述](ui-js-overview.md)
- 框架说明
- [文件组织](js-framework-file.md)
- [js标签配置](js-framework-js-tag.md)
- [app.js](js-framework-js-file.md)
- 语法
- [HML语法参考](js-framework-syntax-hml.md)
- [CSS语法参考](js-framework-syntax-css.md)
- [JS语法参考](js-framework-syntax-js.md)
- [生命周期](js-framework-lifecycle.md)
- [资源限定与访问](js-framework-resource-restriction.md)
- [多语言支持](js-framework-multiple-languages.md)
- 构建用户界面
- [组件介绍](ui-js-building-ui-component.md)
- 构建布局
- [布局说明](ui-js-building-ui-layout-intro.md)
- [添加标题行和文本区域](ui-js-building-ui-layout-text.md)
- [添加图片区域](ui-js-building-ui-layout-image.md)
- [添加留言区域](ui-js-building-ui-layout-comment.md)
- [添加容器](ui-js-building-ui-layout-external-container.md)
- [添加交互](ui-js-building-ui-interactions.md)
- [动画](ui-js-building-ui-animation.md)
- [手势事件](ui-js-building-ui-event.md)
- [页面路由](ui-js-building-ui-routes.md)
- 常见组件开发指导
- 容器组件
- [List开发指导](ui-js-components-list.md)
- [Dialog开发指导](ui-js-components-dialog.md)
- [Form开发指导](ui-js-components-form.md)
- [Stepper开发指导](ui-js-components-stepper.md)
- [Tabs开发指导](ui-js-component-tabs.md)
- [Swiper开发指导](ui-js-components-swiper.md)
- 基础组件
- [Text开发指导](ui-js-components-text.md)
- [Input开发指导](ui-js-components-input.md)
- [Button开发指导](ui-js-components-button.md)
- [Picker开发指导](ui-js-components-picker.md)
- [Image开发指导](ui-js-components-images.md)
- [Image-animator开发指导](ui-js-components-image-animator.md)
- [Rating开发指导](ui-js-components-rating.md)
- [Slider开发指导](ui-js-components-slider.md)
- [Chart开发指导](ui-js-components-chart.md)
- [Switch开发指导](ui-js-components-switch.md)
- [Toolbar开发指导](ui-js-components-toolbar.md)
- [Menu开发指导](ui-js-components-menu.md)
- [Marquee开发指导](ui-js-components-marquee.md)
- [Qrcode开发指导](ui-js-components-qrcode.md)
- [Search开发指导](ui-js-components-search.md)
- Canvas开发指导
- [Canvas对象](ui-js-components-canvas.md)
- [CanvasRenderingContext2D对象](ui-js-components-canvasrenderingcontext2d.md)
- [Path2D对象](ui-js-components-path2d.md)
- [OffscreenCanvas对象](ui-js-components-offscreencanvas.md)
- [栅格布局](ui-js-components-grid.md)
- Svg开发指导
- [基础知识](ui-js-components-svg-overview.md)
- [绘制图形](ui-js-components-svg-graphics.md)
- [绘制路径](ui-js-components-svg-path.md)
- [绘制文本](ui-js-components-svg-text.md)
- 动效开发指导
- CSS动画
- [属性样式动画](ui-js-animate-attribute-style.md)
- [transform样式动画](ui-js-animate-transform.md)
- [background-position样式动画](ui-js-animate-background-position-style.md)
- [svg动画](ui-js-animate-svg.md)
- JS动画
- [组件动画](ui-js-animate-component.md)
- 插值器动画
- [动画动效](ui-js-animate-dynamic-effects.md)
- [动画帧](ui-js-animate-frame.md)
- [自定义组件](ui-js-custom-components.md)
\ No newline at end of file
...@@ -37,6 +37,77 @@ ...@@ -37,6 +37,77 @@
- [测试框架使用指导](ability/ability-delegator.md) - [测试框架使用指导](ability/ability-delegator.md)
- UI开发 - UI开发
- [方舟开发框架(ArkUI)概述](ui/arkui-overview.md) - [方舟开发框架(ArkUI)概述](ui/arkui-overview.md)
- 基于TS扩展的声明式开发范式
- [概述](ui/ui-ts-overview.md)
- 框架说明
- 文件组织
- [目录结构](ui/ts-framework-directory.md)
- [应用代码文件访问规则](ui/ts-framework-file-access-rules.md)
- [js标签配置](ui/ts-framework-js-tag.md)
- 资源管理
- [资源文件的分类](ui/ui-ts-basic-resource-file-categories.md)
- [资源访问](ui/ts-resource-access.md)
- [像素单位](ui/ts-pixel-units.md)
- [类型定义](ui/ts-types.md)
- 声明式语法
- [描述规范使用说明](ui/ts-syntax-intro.md)
- 通用UI描述规范
- [基本概念](ui/ts-general-ui-concepts.md)
- 声明式UI描述规范
- [无构造参数配置](ui/ts-parameterless-configuration.md)
- [必选参数构造配置](ui/ts-configuration-with-mandatory-parameters.md)
- [属性配置](ui/ts-attribution-configuration.md)
- [事件配置](ui/ts-event-configuration.md)
- [子组件配置](ui/ts-child-component-configuration.md)
- 组件化
- [@Component](ui/ts-component-based-component.md)
- [@Entry](ui/ts-component-based-entry.md)
- [@Preview](ui/ts-component-based-preview.md)
- [@Builder](ui/ts-component-based-builder.md)
- [@Extend](ui/ts-component-based-extend.md)
- [@CustomDialog](ui/ts-component-based-customdialog.md)
- [@Styles](ui/ts-component-based-styles.md)
- UI状态管理
- [基本概念](ui/ts-ui-state-mgmt-concepts.md)
- 管理组件拥有的状态
- [@State](ui/ts-component-states-state.md)
- [@Prop](ui/ts-component-states-prop.md)
- [@Link](ui/ts-component-states-link.md)
- 管理应用程序的状态
- [应用程序的数据存储](ui/ts-application-states-appstorage.md)
- [Ability数据存储](ui/ui-ts-local-storage.md)
- [持久化数据管理](ui/ts-application-states-apis-persistentstorage.md)
- [环境变量](ui/ts-application-states-apis-environment.md)
- 其他类目的状态管理
- [Observed和ObjectLink数据管理](ui/ts-other-states-observed-objectlink.md)
- [@Consume和@Provide数据管理](ui/ts-other-states-consume-provide.md)
- [@Watch](ui/ts-other-states-watch.md)
- 渲染控制语法
- [条件渲染](ui/ts-rending-control-syntax-if-else.md)
- [循环渲染](ui/ts-rending-control-syntax-foreach.md)
- [数据懒加载](ui/ts-rending-control-syntax-lazyforeach.md)
- 深入理解组件化
- [build函数](ui/ts-function-build.md)
- [自定义组件初始化](ui/ts-custom-component-initialization.md)
- [自定义组件生命周期回调函数](ui/ts-custom-component-lifecycle-callbacks.md)
- [组件创建和重新初始化示例](ui/ts-component-creation-re-initialization.md)
- [语法糖](ui/ts-syntactic-sugar.md)
- 常见组件开发指导
- [Button开发指导](ui/ui-ts-basic-components-button.md)
- [Web开发指导](ui/ui-ts-components-web.md)
- 常见布局开发指导
- [弹性布局](ui/ui-ts-layout-flex.md)
- [栅格布局](ui/ui-ts-layout-grid-container.md)
- [媒体查询](ui/ui-ts-layout-mediaquery.md)
- 体验声明式UI
- [创建声明式UI工程](ui/ui-ts-creating-project.md)
- [初识Component](ui/ui-ts-components.md)
- [创建简单视图](ui/ui-ts-creating-simple-page.md)
- 页面布局与连接
- [构建食物数据模型](ui/ui-ts-building-data-model.md)
- [构建食物列表List布局](ui/ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui/ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui/ui-ts-page-redirection-data-transmission.md)
- 基于JS扩展的类Web开发范式 - 基于JS扩展的类Web开发范式
- [概述](ui/ui-js-overview.md) - [概述](ui/ui-js-overview.md)
- 框架说明 - 框架说明
...@@ -109,77 +180,6 @@ ...@@ -109,77 +180,6 @@
- [动画动效](ui/ui-js-animate-dynamic-effects.md) - [动画动效](ui/ui-js-animate-dynamic-effects.md)
- [动画帧](ui/ui-js-animate-frame.md) - [动画帧](ui/ui-js-animate-frame.md)
- [自定义组件](ui/ui-js-custom-components.md) - [自定义组件](ui/ui-js-custom-components.md)
- 基于TS扩展的声明式开发范式
- [概述](ui/ui-ts-overview.md)
- 框架说明
- 文件组织
- [目录结构](ui/ts-framework-directory.md)
- [应用代码文件访问规则](ui/ts-framework-file-access-rules.md)
- [js标签配置](ui/ts-framework-js-tag.md)
- 资源管理
- [资源文件的分类](ui/ui-ts-basic-resource-file-categories.md)
- [资源访问](ui/ts-resource-access.md)
- [像素单位](ui/ts-pixel-units.md)
- [类型定义](ui/ts-types.md)
- 声明式语法
- [描述规范使用说明](ui/ts-syntax-intro.md)
- 通用UI描述规范
- [基本概念](ui/ts-general-ui-concepts.md)
- 声明式UI描述规范
- [无构造参数配置](ui/ts-parameterless-configuration.md)
- [必选参数构造配置](ui/ts-configuration-with-mandatory-parameters.md)
- [属性配置](ui/ts-attribution-configuration.md)
- [事件配置](ui/ts-event-configuration.md)
- [子组件配置](ui/ts-child-component-configuration.md)
- 组件化
- [@Component](ui/ts-component-based-component.md)
- [@Entry](ui/ts-component-based-entry.md)
- [@Preview](ui/ts-component-based-preview.md)
- [@Builder](ui/ts-component-based-builder.md)
- [@Extend](ui/ts-component-based-extend.md)
- [@CustomDialog](ui/ts-component-based-customdialog.md)
- [@Styles](ui/ts-component-based-styles.md)
- UI状态管理
- [基本概念](ui/ts-ui-state-mgmt-concepts.md)
- 管理组件拥有的状态
- [@State](ui/ts-component-states-state.md)
- [@Prop](ui/ts-component-states-prop.md)
- [@Link](ui/ts-component-states-link.md)
- 管理应用程序的状态
- [应用程序的数据存储](ui/ts-application-states-appstorage.md)
- [Ability数据存储](ui/ui-ts-local-storage.md)
- [持久化数据管理](ui/ts-application-states-apis-persistentstorage.md)
- [环境变量](ui/ts-application-states-apis-environment.md)
- 其他类目的状态管理
- [Observed和ObjectLink数据管理](ui/ts-other-states-observed-objectlink.md)
- [@Consume和@Provide数据管理](ui/ts-other-states-consume-provide.md)
- [@Watch](ui/ts-other-states-watch.md)
- 渲染控制语法
- [条件渲染](ui/ts-rending-control-syntax-if-else.md)
- [循环渲染](ui/ts-rending-control-syntax-foreach.md)
- [数据懒加载](ui/ts-rending-control-syntax-lazyforeach.md)
- 深入理解组件化
- [build函数](ui/ts-function-build.md)
- [自定义组件初始化](ui/ts-custom-component-initialization.md)
- [自定义组件生命周期回调函数](ui/ts-custom-component-lifecycle-callbacks.md)
- [组件创建和重新初始化示例](ui/ts-component-creation-re-initialization.md)
- [语法糖](ui/ts-syntactic-sugar.md)
- 常见组件开发指导
- [Button开发指导](ui/ui-ts-basic-components-button.md)
- [Web开发指导](ui/ui-ts-components-web.md)
- 常见布局开发指导
- [弹性布局](ui/ui-ts-layout-flex.md)
- [栅格布局](ui/ui-ts-layout-grid-container.md)
- [媒体查询](ui/ui-ts-layout-mediaquery.md)
- 体验声明式UI
- [创建声明式UI工程](ui/ui-ts-creating-project.md)
- [初识Component](ui/ui-ts-components.md)
- [创建简单视图](ui/ui-ts-creating-simple-page.md)
- 页面布局与连接
- [构建食物数据模型](ui/ui-ts-building-data-model.md)
- [构建食物列表List布局](ui/ui-ts-building-category-list-layout.md)
- [构建食物分类Grid布局](ui/ui-ts-building-category-grid-layout.md)
- [页面跳转与数据传递](ui/ui-ts-page-redirection-data-transmission.md)
- 公共事件与通知 - 公共事件与通知
- [公共事件与通知概述](notification/notification-brief.md) - [公共事件与通知概述](notification/notification-brief.md)
- [公共事件开发指导](notification/common-event.md) - [公共事件开发指导](notification/common-event.md)
...@@ -377,108 +377,6 @@ ...@@ -377,108 +377,6 @@
- [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md) - [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md)
- [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md) - [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md)
- API参考 - API参考
- 组件参考(基于JS扩展的类Web开发范式)
- 组件通用信息
- [通用属性](reference/arkui-js/js-components-common-attributes.md)
- [通用样式](reference/arkui-js/js-components-common-styles.md)
- [通用事件](reference/arkui-js/js-components-common-events.md)
- [通用方法](reference/arkui-js/js-components-common-methods.md)
- [动画样式](reference/arkui-js/js-components-common-animation.md)
- [渐变样式](reference/arkui-js/js-components-common-gradient.md)
- [转场样式](reference/arkui-js/js-components-common-transition.md)
- [媒体查询](reference/arkui-js/js-components-common-mediaquery.md)
- [自定义字体样式](reference/arkui-js/js-components-common-customizing-font.md)
- [原子布局](reference/arkui-js/js-components-common-atomic-layout.md)
- 容器组件
- [badge](reference/arkui-js/js-components-container-badge.md)
- [dialog](reference/arkui-js/js-components-container-dialog.md)
- [div](reference/arkui-js/js-components-container-div.md)
- [form](reference/arkui-js/js-components-container-form.md)
- [list](reference/arkui-js/js-components-container-list.md)
- [list-item](reference/arkui-js/js-components-container-list-item.md)
- [list-item-group](reference/arkui-js/js-components-container-list-item-group.md)
- [panel](reference/arkui-js/js-components-container-panel.md)
- [popup](reference/arkui-js/js-components-container-popup.md)
- [refresh](reference/arkui-js/js-components-container-refresh.md)
- [stack](reference/arkui-js/js-components-container-stack.md)
- [stepper](reference/arkui-js/js-components-container-stepper.md)
- [stepper-item](reference/arkui-js/js-components-container-stepper-item.md)
- [swiper](reference/arkui-js/js-components-container-swiper.md)
- [tabs](reference/arkui-js/js-components-container-tabs.md)
- [tab-bar](reference/arkui-js/js-components-container-tab-bar.md)
- [tab-content](reference/arkui-js/js-components-container-tab-content.md)
- 基础组件
- [button](reference/arkui-js/js-components-basic-button.md)
- [chart](reference/arkui-js/js-components-basic-chart.md)
- [divider](reference/arkui-js/js-components-basic-divider.md)
- [image](reference/arkui-js/js-components-basic-image.md)
- [image-animator](reference/arkui-js/js-components-basic-image-animator.md)
- [input](reference/arkui-js/js-components-basic-input.md)
- [label](reference/arkui-js/js-components-basic-label.md)
- [marquee](reference/arkui-js/js-components-basic-marquee.md)
- [menu](reference/arkui-js/js-components-basic-menu.md)
- [option](reference/arkui-js/js-components-basic-option.md)
- [picker](reference/arkui-js/js-components-basic-picker.md)
- [picker-view](reference/arkui-js/js-components-basic-picker-view.md)
- [piece](reference/arkui-js/js-components-basic-piece.md)
- [progress](reference/arkui-js/js-components-basic-progress.md)
- [qrcode](reference/arkui-js/js-components-basic-qrcode.md)
- [rating](reference/arkui-js/js-components-basic-rating.md)
- [richtext](reference/arkui-js/js-components-basic-richtext.md)
- [search](reference/arkui-js/js-components-basic-search.md)
- [select](reference/arkui-js/js-components-basic-select.md)
- [slider](reference/arkui-js/js-components-basic-slider.md)
- [span](reference/arkui-js/js-components-basic-span.md)
- [switch](reference/arkui-js/js-components-basic-switch.md)
- [text](reference/arkui-js/js-components-basic-text.md)
- [textarea](reference/arkui-js/js-components-basic-textarea.md)
- [toolbar](reference/arkui-js/js-components-basic-toolbar.md)
- [toolbar-item](reference/arkui-js/js-components-basic-toolbar-item.md)
- [toggle](reference/arkui-js/js-components-basic-toggle.md)
- [web](reference/arkui-js/js-components-basic-web.md)
- [xcomponent](reference/arkui-js/js-components-basic-xcomponent.md)
- 媒体组件
- [video](reference/arkui-js/js-components-media-video.md)
- 画布组件
- [canvas组件](reference/arkui-js/js-components-canvas-canvas.md)
- [CanvasRenderingContext2D对象](reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md)
- [Image对象](reference/arkui-js/js-components-canvas-image.md)
- [CanvasGradient对象](reference/arkui-js/js-components-canvas-canvasgradient.md)
- [ImageData对象](reference/arkui-js/js-components-canvas-imagedata.md)
- [Path2D对象](reference/arkui-js/js-components-canvas-path2d.md)
- [ImageBitmap对象](reference/arkui-js/js-components-canvas-imagebitmap.md)
- [OffscreenCanvas对象](reference/arkui-js/js-components-canvas-offscreencanvas.md)
- [OffscreenCanvasRenderingContext2D对象](reference/arkui-js/js-offscreencanvasrenderingcontext2d.md)
- 栅格组件
- [基本概念](reference/arkui-js/js-components-grid-basic-concepts.md)
- [grid-container](reference/arkui-js/js-components-grid-container.md)
- [grid-row](reference/arkui-js/js-components-grid-row.md)
- [grid-col](reference/arkui-js/js-components-grid-col.md)
- svg组件
- [通用属性](reference/arkui-js/js-components-svg-common-attributes.md)
- [svg](reference/arkui-js/js-components-svg.md)
- [rect](reference/arkui-js/js-components-svg-rect.md)
- [circle](reference/arkui-js/js-components-svg-circle.md)
- [ellipse](reference/arkui-js/js-components-svg-ellipse.md)
- [path](reference/arkui-js/js-components-svg-path.md)
- [line](reference/arkui-js/js-components-svg-line.md)
- [polyline](reference/arkui-js/js-components-svg-polyline.md)
- [polygon](reference/arkui-js/js-components-svg-polygon.md)
- [text](reference/arkui-js/js-components-svg-text.md)
- [tspan](reference/arkui-js/js-components-svg-tspan.md)
- [textPath](reference/arkui-js/js-components-svg-textpath.md)
- [animate](reference/arkui-js/js-components-svg-animate.md)
- [animateMotion](reference/arkui-js/js-components-svg-animatemotion.md)
- [animateTransform](reference/arkui-js/js-components-svg-animatetransform.md)
- 自定义组件
- [基本用法](reference/arkui-js/js-components-custom-basic-usage.md)
- [继承样式](reference/arkui-js/js-components-custom-style.md)
- [自定义事件](reference/arkui-js/js-components-custom-events.md)
- [Props](reference/arkui-js/js-components-custom-props.md)
- [事件参数](reference/arkui-js/js-components-custom-event-parameter.md)
- [slot插槽](reference/arkui-js/js-components-custom-slot.md)
- [生命周期定义](reference/arkui-js/js-components-custom-lifecycle.md)
- [数据类型说明](reference/arkui-js/js-appendix-types.md)
- 组件参考(基于TS扩展的声明式开发范式) - 组件参考(基于TS扩展的声明式开发范式)
- 组件通用信息 - 组件通用信息
- 通用事件 - 通用事件
...@@ -632,6 +530,108 @@ ...@@ -632,6 +530,108 @@
- [文本选择弹窗](reference/arkui-ts/ts-methods-textpicker-dialog.md) - [文本选择弹窗](reference/arkui-ts/ts-methods-textpicker-dialog.md)
- [菜单](reference/arkui-ts/ts-methods-menu.md) - [菜单](reference/arkui-ts/ts-methods-menu.md)
- [文档中涉及到的内置枚举值](reference/arkui-ts/ts-appendix-enums.md) - [文档中涉及到的内置枚举值](reference/arkui-ts/ts-appendix-enums.md)
- 组件参考(基于JS扩展的类Web开发范式)
- 组件通用信息
- [通用属性](reference/arkui-js/js-components-common-attributes.md)
- [通用样式](reference/arkui-js/js-components-common-styles.md)
- [通用事件](reference/arkui-js/js-components-common-events.md)
- [通用方法](reference/arkui-js/js-components-common-methods.md)
- [动画样式](reference/arkui-js/js-components-common-animation.md)
- [渐变样式](reference/arkui-js/js-components-common-gradient.md)
- [转场样式](reference/arkui-js/js-components-common-transition.md)
- [媒体查询](reference/arkui-js/js-components-common-mediaquery.md)
- [自定义字体样式](reference/arkui-js/js-components-common-customizing-font.md)
- [原子布局](reference/arkui-js/js-components-common-atomic-layout.md)
- 容器组件
- [badge](reference/arkui-js/js-components-container-badge.md)
- [dialog](reference/arkui-js/js-components-container-dialog.md)
- [div](reference/arkui-js/js-components-container-div.md)
- [form](reference/arkui-js/js-components-container-form.md)
- [list](reference/arkui-js/js-components-container-list.md)
- [list-item](reference/arkui-js/js-components-container-list-item.md)
- [list-item-group](reference/arkui-js/js-components-container-list-item-group.md)
- [panel](reference/arkui-js/js-components-container-panel.md)
- [popup](reference/arkui-js/js-components-container-popup.md)
- [refresh](reference/arkui-js/js-components-container-refresh.md)
- [stack](reference/arkui-js/js-components-container-stack.md)
- [stepper](reference/arkui-js/js-components-container-stepper.md)
- [stepper-item](reference/arkui-js/js-components-container-stepper-item.md)
- [swiper](reference/arkui-js/js-components-container-swiper.md)
- [tabs](reference/arkui-js/js-components-container-tabs.md)
- [tab-bar](reference/arkui-js/js-components-container-tab-bar.md)
- [tab-content](reference/arkui-js/js-components-container-tab-content.md)
- 基础组件
- [button](reference/arkui-js/js-components-basic-button.md)
- [chart](reference/arkui-js/js-components-basic-chart.md)
- [divider](reference/arkui-js/js-components-basic-divider.md)
- [image](reference/arkui-js/js-components-basic-image.md)
- [image-animator](reference/arkui-js/js-components-basic-image-animator.md)
- [input](reference/arkui-js/js-components-basic-input.md)
- [label](reference/arkui-js/js-components-basic-label.md)
- [marquee](reference/arkui-js/js-components-basic-marquee.md)
- [menu](reference/arkui-js/js-components-basic-menu.md)
- [option](reference/arkui-js/js-components-basic-option.md)
- [picker](reference/arkui-js/js-components-basic-picker.md)
- [picker-view](reference/arkui-js/js-components-basic-picker-view.md)
- [piece](reference/arkui-js/js-components-basic-piece.md)
- [progress](reference/arkui-js/js-components-basic-progress.md)
- [qrcode](reference/arkui-js/js-components-basic-qrcode.md)
- [rating](reference/arkui-js/js-components-basic-rating.md)
- [richtext](reference/arkui-js/js-components-basic-richtext.md)
- [search](reference/arkui-js/js-components-basic-search.md)
- [select](reference/arkui-js/js-components-basic-select.md)
- [slider](reference/arkui-js/js-components-basic-slider.md)
- [span](reference/arkui-js/js-components-basic-span.md)
- [switch](reference/arkui-js/js-components-basic-switch.md)
- [text](reference/arkui-js/js-components-basic-text.md)
- [textarea](reference/arkui-js/js-components-basic-textarea.md)
- [toolbar](reference/arkui-js/js-components-basic-toolbar.md)
- [toolbar-item](reference/arkui-js/js-components-basic-toolbar-item.md)
- [toggle](reference/arkui-js/js-components-basic-toggle.md)
- [web](reference/arkui-js/js-components-basic-web.md)
- [xcomponent](reference/arkui-js/js-components-basic-xcomponent.md)
- 媒体组件
- [video](reference/arkui-js/js-components-media-video.md)
- 画布组件
- [canvas组件](reference/arkui-js/js-components-canvas-canvas.md)
- [CanvasRenderingContext2D对象](reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md)
- [Image对象](reference/arkui-js/js-components-canvas-image.md)
- [CanvasGradient对象](reference/arkui-js/js-components-canvas-canvasgradient.md)
- [ImageData对象](reference/arkui-js/js-components-canvas-imagedata.md)
- [Path2D对象](reference/arkui-js/js-components-canvas-path2d.md)
- [ImageBitmap对象](reference/arkui-js/js-components-canvas-imagebitmap.md)
- [OffscreenCanvas对象](reference/arkui-js/js-components-canvas-offscreencanvas.md)
- [OffscreenCanvasRenderingContext2D对象](reference/arkui-js/js-offscreencanvasrenderingcontext2d.md)
- 栅格组件
- [基本概念](reference/arkui-js/js-components-grid-basic-concepts.md)
- [grid-container](reference/arkui-js/js-components-grid-container.md)
- [grid-row](reference/arkui-js/js-components-grid-row.md)
- [grid-col](reference/arkui-js/js-components-grid-col.md)
- svg组件
- [通用属性](reference/arkui-js/js-components-svg-common-attributes.md)
- [svg](reference/arkui-js/js-components-svg.md)
- [rect](reference/arkui-js/js-components-svg-rect.md)
- [circle](reference/arkui-js/js-components-svg-circle.md)
- [ellipse](reference/arkui-js/js-components-svg-ellipse.md)
- [path](reference/arkui-js/js-components-svg-path.md)
- [line](reference/arkui-js/js-components-svg-line.md)
- [polyline](reference/arkui-js/js-components-svg-polyline.md)
- [polygon](reference/arkui-js/js-components-svg-polygon.md)
- [text](reference/arkui-js/js-components-svg-text.md)
- [tspan](reference/arkui-js/js-components-svg-tspan.md)
- [textPath](reference/arkui-js/js-components-svg-textpath.md)
- [animate](reference/arkui-js/js-components-svg-animate.md)
- [animateMotion](reference/arkui-js/js-components-svg-animatemotion.md)
- [animateTransform](reference/arkui-js/js-components-svg-animatetransform.md)
- 自定义组件
- [基本用法](reference/arkui-js/js-components-custom-basic-usage.md)
- [继承样式](reference/arkui-js/js-components-custom-style.md)
- [自定义事件](reference/arkui-js/js-components-custom-events.md)
- [Props](reference/arkui-js/js-components-custom-props.md)
- [事件参数](reference/arkui-js/js-components-custom-event-parameter.md)
- [slot插槽](reference/arkui-js/js-components-custom-slot.md)
- [生命周期定义](reference/arkui-js/js-components-custom-lifecycle.md)
- [数据类型说明](reference/arkui-js/js-appendix-types.md)
- 接口参考(JS及TS API) - 接口参考(JS及TS API)
- [开发说明](reference/apis/development-intro.md) - [开发说明](reference/apis/development-intro.md)
- Ability框架 - Ability框架
...@@ -746,7 +746,7 @@ ...@@ -746,7 +746,7 @@
- [@ohos.resourceManager (资源管理)](reference/apis/js-apis-resource-manager.md) - [@ohos.resourceManager (资源管理)](reference/apis/js-apis-resource-manager.md)
- 资源调度 - 资源调度
- [@ohos.backgroundTaskManager (后台任务管理)](reference/apis/js-apis-backgroundTaskManager.md) - [@ohos.backgroundTaskManager (后台任务管理)](reference/apis/js-apis-backgroundTaskManager.md)
- [@ohos.distributedMissionManager (distributedMissionManager)](reference/apis/js-apis-distributedMissionManager.md) - [@ohos.distributedMissionManager (分布式任务管理)](reference/apis/js-apis-distributedMissionManager.md)
- [@ohos.workScheduler (延迟任务调度)](reference/apis/js-apis-workScheduler.md) - [@ohos.workScheduler (延迟任务调度)](reference/apis/js-apis-workScheduler.md)
- [@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)](reference/apis/js-apis-WorkSchedulerExtensionAbility.md) - [@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)](reference/apis/js-apis-WorkSchedulerExtensionAbility.md)
- 定制管理 - 定制管理
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册