Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 62e3640d 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7393 PR同步 

Merge pull request !7393 from LiAn/OpenHarmony-3.2-Beta2
上级 2e098766 53e5ce74
展开全部 显示空白变更内容
内联 并排
Showing with 2055 addition and 2112 deletion
en/application-dev/application-dev-guide-for-gitee.md
浏览文件 @ 62e3640d
......@@ -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.
They are organized as follows:
- [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)
- [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md)
- APIs
- [JS and TS APIs](reference/apis/Readme-EN.md)
- Native APIs
......
en/application-dev/application-dev-guide.md
浏览文件 @ 62e3640d
......@@ -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.
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)
- Native APIs
- [Standard Library](reference/native-lib/third_party_libc/musl.md)
......
en/application-dev/reference/Readme-EN.md
浏览文件 @ 62e3640d
# Development References
- [JavaScript-based Web-like Development Paradigm](arkui-js/Readme-EN.md)
- [TypeScript-based Declarative Development Paradigm](arkui-ts/Readme-EN.md)
- [Component Reference(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)
- [JS (eTS Included) APIs](apis/Readme-EN.md)
......
en/application-dev/ui/Readme-EN.md
浏览文件 @ 62e3640d
# UI Development
- [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
- [Overview](ui-js-overview.md)
- Framework
......@@ -73,74 +144,4 @@
- [Animation Effect](ui-js-animate-dynamic-effects.md)
- [Animation Frame](ui-js-animate-frame.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)
en/application-dev/website.md
浏览文件 @ 62e3640d
此差异已折叠。
zh-cn/application-dev/Readme-CN.md
浏览文件 @ 62e3640d
......@@ -42,8 +42,8 @@
- [示例代码](https://gitee.com/openharmony/app_samples/blob/master/README_zh.md)
- [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md)
- API参考
- [组件参考（基于JS扩展的类Web开发范式）](reference/arkui-js/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)
- Native API
......
zh-cn/application-dev/application-dev-guide-for-gitee.md
浏览文件 @ 62e3640d
......@@ -54,8 +54,11 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。
API参考提供了OpenHarmony全量组件和接口的参考文档，可以帮助开发者快速查找到指定接口的详细描述和调用方法。
内容包括：
- [组件参考（基于JS扩展的类Web开发范式）](reference/arkui-js/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)
- Native API
......
zh-cn/application-dev/application-dev-guide.md
浏览文件 @ 62e3640d
......@@ -55,6 +55,12 @@ DevEco Studio工具是OpenHarmony应用开发的推荐IDE工具。
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)
- 接口参考（Native API）
- [OpenHarmony Native API](reference/native-apis/_o_h___native_x_component.md)
......
zh-cn/application-dev/reference/Readme-CN.md
浏览文件 @ 62e3640d
# 开发参考
- [基于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)
- 接口参考（Native API）
- [OpenHarmony Native API](./native-apis/Readme-CN.md)
......
zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
浏览文件 @ 62e3640d
......@@ -4,13 +4,14 @@
开发者在开发应用时，通过复写该模块的接口，在延迟任务触发的时候，系统会通过接口回调应用，开发者在回调接口里面可以处理自己的任务逻辑。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
```ts
import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'
```
......@@ -25,12 +26,12 @@ onWorkStart(work: workScheduler.WorkInfo): void
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
**示例：**
```
```ts
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStart(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
......@@ -49,13 +50,13 @@ onWorkStop(work: workScheduler.WorkInfo): void
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---- | --------------------- | ---- | -------------- |
| ---- | ---------------------------------------- | ---- | -------------- |
| work | [workScheduler.WorkInfo](js-apis-workScheduler.md#workinfo) | 是 | 指示要添加到执行队列的工作。 |
**示例：**
```
```ts
export default class MyWorkSchedulerExtensionAbility extends WorkSchedulerExtensionAbility {
onWorkStop(workInfo) {
console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
......
zh-cn/application-dev/reference/apis/js-apis-accessibility-extension-context.md
浏览文件 @ 62e3640d
......@@ -12,7 +12,7 @@ AccessibilityExtensionContext模块提供扩展的上下文的能力，包括允
## 导入模块
```js
import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExtensionAbility'
import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
```
## FocusDirection
......@@ -22,7 +22,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| -------- | ------- |
| up | 表示向上查询。 |
| down | 表示向上查询。 |
| left | 表示向左查询。 |
......@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ------------- | ----------- |
| accessibility | 表示无障碍的焦点类型。 |
| normal | 表示普通的焦点类型。 |
......@@ -50,7 +50,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 参数
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------ | -------- | ---- | ---- | ------------------ |
| ------ | ------ | ---- | ---- | --------- |
| left | number | 是 | 否 | 矩形区域的左边界。 |
| top | number | 是 | 否 | 矩形区域的上边界。 |
| width | number | 是 | 否 | 矩形区域的宽度。 |
......@@ -63,7 +63,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ----------- | --------- |
| application | 表示应用窗口类型。 |
| system | 表示系统窗口类型。 |
......@@ -78,13 +78,13 @@ setEventTypeFilter(type: Array<accessibility.EventType>): Promise\<boolean>;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| ---- | ---------------------------------------- | ---- | -------- |
| type | Array&lt;[EventType](js-apis-accessibility.md#EventType)&gt; | 是 | 关注的事件类型。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 |
**示例：**
......@@ -104,13 +104,13 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<boolean>;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| ----------- | ------------------- | ---- | -------- |
| targetNames | Array&lt;string&gt; | 是 | 关注的目标包名。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ---------------------- | --------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回当前设置是否成功。 |
**示例：**
......@@ -130,13 +130,13 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素，默认为否。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ----------------------------------- | ---------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的焦点元素。 |
**示例：**
......@@ -158,13 +158,13 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| -------- | ------ | ---- | --------------------------- |
| windowId | number | 否 | 指定获取根节点元素的窗口，未指定则从当前活跃窗口获取。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ----------------------------------- | ----------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象。返回当前对应的根节点元素。 |
**示例：**
......@@ -186,13 +186,13 @@ getWindows(displayId?: number): Promise<Array\<AccessibilityElement>>;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| --------- | ------ | ---- | ------------------------- |
| displayId | number | 否 | 指定获取窗口信息的屏幕，未指定则从默认主屏幕获取。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ---------------------------------------- | ------------------------ |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise对象。返回当前对应的窗口列表信息。 |
**示例：**
......@@ -214,14 +214,14 @@ gestureInject(gesturePath: GesturePath, listener: Callback\<boolean>): Promise\<
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| ----------- | ---------------------------------------- | ---- | -------------- |
| gesturePath | [GesturePath](js-apis-application-AccessibilityExtensionAbility.md#GesturePath) | 是 | 表示手势的路径信息。 |
| listener | Callback&lt;boolean&gt; | 是 | 表示注入手势执行结果的回调。 |
**返回值：**
| 类型 | 说明 |
| -------------------------------- | --------------------------------------- |
| ---------------------- | ---------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回注入手势的调用结果。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-animator.md
浏览文件 @ 62e3640d
......@@ -9,7 +9,7 @@
## 导入模块
```
```js
import animator from '@ohos.animator';
```
......@@ -24,17 +24,17 @@ createAnimator(options: AnimatorOptions): AnimatorResult
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。|
| ------- | ----------------------------------- | ---- | ------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| --------------------------------- | ------------- |
| [AnimatorResult](#animatorresult) | Animator结果接口。 |
**示例：**
```
```html
<!-- hml -->
<div class="container">
<div class="Animation" style="height: {{divHeight}}px; width: {{divWidth}}px; background-color: red;" onclick="Show">
......@@ -42,7 +42,7 @@ createAnimator(options: AnimatorOptions): AnimatorResult
</div>
```
```
```js
// js
export default {
data : {
......@@ -95,11 +95,11 @@ update(options: AnimatorOptions): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。|
| ------- | ----------------------------------- | ---- | ------- |
| options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。 |
**示例：**
```
```js
animator.update(options);
```
......@@ -112,7 +112,7 @@ play(): void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.play();
```
......@@ -125,7 +125,7 @@ finish(): void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.finish();
```
......@@ -138,7 +138,7 @@ pause(): void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.pause();
```
......@@ -151,7 +151,7 @@ cancel(): void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.cancel();
```
......@@ -164,7 +164,7 @@ reverse(): void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.reverse();
```
......@@ -178,11 +178,11 @@ onframe: (progress: number) => void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| progress | number | 是 | 动画的当前进度。|
| -------- | ------ | ---- | -------- |
| progress | number | 是 | 动画的当前进度。 |
**示例：**
```
```js
animator.onframe();
```
......@@ -195,7 +195,7 @@ onfinish: () => void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.onfinish();
```
......@@ -208,7 +208,7 @@ oncancel: () => void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.oncancel();
```
......@@ -221,7 +221,7 @@ onrepeat: () => void
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
**示例：**
```
```js
animator.onrepeat();
```
......@@ -232,12 +232,12 @@ animator.onrepeat();
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ---------------------------------------- | ---- | ---------------------------------------- |
| duration | number | 是 | 动画播放的时长，单位毫秒，默认为0。 |
| easing | string | 是 | 动画插值曲线，默认为'ease'。 |
| delay | number | 是 | 动画延时播放时长，单位毫秒，默认为0，即不延时。 |
| 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时无限次播放。 |
| begin | number | 是 | 动画插值起点，默认为0。 |
| end | number | 是 | 动画插值终点，默认为1。 |
zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md
浏览文件 @ 62e3640d
......@@ -11,7 +11,7 @@
## 导入模块
```ts
import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExtensionAbility'
import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility'
```
## AccessibilityEvent
......@@ -23,7 +23,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------- | ---------------------------------------- | ---- | ---- | ---------- |
| eventType | [EventType](js-apis-accessibility.md#EventType) \| [WindowUpdateType](js-apis-accessibility.md#WindowUpdateType) \| [TouchGuideType](touchguidetype) \| [GestureType](gesturetype) \| [PageUpdateType](pageupdatetype) | 是 | 否 | 具体事件类型。 |
| target | AccessibilityElement | 是 | 否 | 发生事件的目标组件。 |
| timeStamp | number | 是 | 否 | 事件时间戳。 |
......@@ -37,7 +37,7 @@ import AccessibilityExtensionAbility from './@ohos.application.AccessibilityExte
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------ | ---------------------------------------- | ---- | ---- | ------ |
| points | Array&lt;[GesturePoint](gesturepoint)&gt; | 是 | 是 | 手势。 |
| durationTime | number | 是 | 是 | 手势总耗时。 |
......@@ -52,7 +52,7 @@ constructor(durationTime: number)
- 参数：
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------ | ------ | ---- | ------ |
| durationTime | number | 是 | 手势总耗时。 |
- 示例
......@@ -70,7 +70,7 @@ constructor(durationTime: number)
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------- | ------ | ---- | ---- | ------- |
| positionX | number | 是 | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 是 | 触摸点Y坐标。 |
......@@ -85,7 +85,7 @@ constructor(positionX: number, positionY: number)
- 参数：
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| --------- | ------ | ---- | ------- |
| positionX | number | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 触摸点Y坐标。 |
......@@ -102,7 +102,7 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ------------- | ------------ |
| left | 表示向左的手势。 |
| leftThenRight | 表示先向左再向右的手势。 |
| leftThenUp | 表示先向左再向上的手势。 |
......@@ -127,7 +127,7 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ----------------- | --------- |
| pageContentUpdate | 表示页面内容刷新。 |
| pageStateUpdate | 表示页面状态刷新。 |
......@@ -138,7 +138,7 @@ constructor(positionX: number, positionY: number)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.Barrierfree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ---------- | ------------ |
| touchBegin | 表示触摸浏览时开始触摸。 |
| touchEnd | 表示触摸浏览时结束触摸。 |
......@@ -193,7 +193,7 @@ onAccessibilityEvent(event: AccessibilityEvent): void;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| ----- | ---------------------------------------- | ---- | --------------- |
| event | [AccessibilityEvent](accessibilityevent) | 是 | 无障碍事件回调函数。无返回值。 |
**示例：**
......@@ -218,7 +218,7 @@ onKeyEvent(keyEvent: inputEventClient.KeyEvent): boolean;
**参数：**
| 参数名 | 参数类型 | 必填 | 说明 |
| ----- | ------ | ------ | ------ |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| keyEvent | [KeyEvent](js-apis-inputeventclient.md#KeyEvent) | 是 | 按键事件回调函数。返回true表示拦截此按键。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md
浏览文件 @ 62e3640d
......@@ -8,13 +8,13 @@
应用中存在用户能够直观感受到的且需要一直在后台运行的业务时（如，后台播放音乐），可以使用长时任务机制。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
```js
import backgroundTaskManager from '@ohos.backgroundTaskManager';
```
......@@ -144,7 +144,7 @@ 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)。 |
| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 |
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击后跳转的界面。 |
......@@ -196,7 +196,7 @@ 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)。 |
| bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 |
| wantAgent | [WantAgent](js-apis-wantAgent.md) | 是 | 通知参数，用于指定长时任务通知点击跳转的界面。 |
......@@ -245,7 +245,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback&lt;void&gt;): vo
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------- | ---- | ---------------------- |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| 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形式返回启动长时任务的结果。 |
......@@ -276,7 +276,7 @@ stopBackgroundRunning(context: Context): Promise&lt;void&gt;
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------- | ---- | --------- |
| ------- | ------- | ---- | ---------------------------------------- |
| 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(()
延迟挂起信息。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------ | ---- | ---------------------------------------- |
......@@ -311,16 +311,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
## BackgroundMode<sup>8+</sup>
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 |
| ----------------------- | ------ | ------------------------------------------------------------ |
| ----------------------- | ---- | --------------------- |
| DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关<br />**系统API**：此接口为系统接口，三方应用不支持调用。 |
| VOIP | 8 | 音视频通话<br />**系统API**：此接口为系统接口，三方应用不支持调用。 |
| WIFI_INTERACTION | 7 | WLAN相关<br />此接口为系统接口。 |
| VOIP | 8 | 音视频通话<br />此接口为系统接口。 |
| TASK_KEEPING | 9 | 计算任务（仅在特定设备生效） |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-config-policy.md
浏览文件 @ 62e3640d
......@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块接口均为系统接口，三方应用不支持调用。
> 本模块接口均为系统接口。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-device-manager.md
浏览文件 @ 62e3640d
......@@ -33,7 +33,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
- 参数：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ---------------------------------------- | ---- | ------------------------------------ |
| bundleName | string | 是 | 指示应用程序的包名。 |
| callback | AsyncCallback&lt;[DeviceManager](#devicemanager)&gt; | 是 | DeviceManager实例创建时调用的回调，返回设备管理器对象实例。 |
......@@ -45,7 +45,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
return;
}
console.info("createDeviceManager success");
this.dmInstance = data;
let dmInstance = data;
});
```
......@@ -56,7 +56,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |
| ---------------------- | ------------------------- | ---- | -------- |
| deviceId | string | 是 | 设备的唯一标识。 |
| deviceName | string | 是 | 设备名称。 |
| deviceType | [DeviceType](#devicetype) | 是 | 设备类型。 |
......@@ -70,7 +70,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------ | ---- | ---- |
| SPEAKER | 0x0A | 智能音箱 |
| PHONE | 0x0E | 手机 |
| TABLET | 0x11 | 平板 |
......@@ -87,7 +87,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------- | ---- | --------------- |
| ONLINE | 0 | 设备上线。 |
| READY | 1 | 设备就绪，设备信息同步已完成。 |
| OFFLINE | 2 | 设备下线。 |
......@@ -100,7 +100,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |
| ------------- | --------------------------------- | ---- | ----------------- |
| subscribeId | number | 是 | 发现标识，用于标识不同的发现周期。 |
| mode | [DiscoverMode ](#discovermode) | 否 | 发现模式。 |
| medium | [ExchangeMedium](#exchangemedium) | 否 | 发现类型。 |
......@@ -117,7 +117,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| --------------------- | ---- | ----- |
| DISCOVER_MODE_PASSIVE | 0x55 | 被动模式。 |
| DISCOVER_MODE_ACTIVE | 0xAA | 主动模式。 |
......@@ -129,7 +129,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ---- | ---- | --------- |
| AUTO | 0 | 自动发现类型。 |
| BLE | 1 | 蓝牙发现类型。 |
| COAP | 2 | WiFi发现类型。 |
......@@ -142,7 +142,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ---------- | ---- | ----- |
| LOW | 0 | 低频率。 |
| MID | 1 | 中频率。 |
| HIGH | 2 | 高频率。 |
......@@ -156,7 +156,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ------------------------- | ---- | -------------- |
| SUBSCRIBE_CAPABILITY_DDMP | 0 | DDMP能力，后续会被废弃。 |
| SUBSCRIBE_CAPABILITY_OSD | 1 | OSD能力。 |
......@@ -168,7 +168,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |
| --------- | -------------------- | ---- | ---------- |
| authType | number | 是 | 认证类型。 |
| extraInfo | {[key:string] : any} | 否 | 认证参数可扩展字段。 |
......@@ -179,7 +179,7 @@ createDeviceManager(bundleName: string, callback: AsyncCallback&lt;DeviceManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.DistributedHardware.DeviceManager
| 名称 | 类型 | 必填 | 描述 |
| -------- | -------- | -------- | -------- |
| --------- | -------------------- | ---- | ---------- |
| authType | number | 是 | 认证类型。 |
| token | number | 是 | 认证Token。 |
| extraInfo | {[key:string] : any} | 否 | 认证信息可扩展字段。 |
......@@ -214,7 +214,7 @@ getTrustedDeviceListSync(): Array&lt;DeviceInfo&gt;
- 返回值：
| 名称 | 说明 |
| -------- | -------- |
| -------------------------------------- | --------- |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回可信设备列表。 |
- 示例：
......@@ -233,7 +233,7 @@ getTrustedDeviceList(callback:AsyncCallback&lt;Array&lt;DeviceInfo&gt;&gt;): voi
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | 是 | 获取所有可信设备列表的回调，返回设备信息。 |
- 示例：
......@@ -255,7 +255,7 @@ getTrustedDeviceList(): Promise&lt;Array&lt;DeviceInfo&gt;&gt;
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[DeviceInfo](#deviceinfo)&gt;&gt; | Promise实例，用于获取异步返回结果。 |
- 示例：
......@@ -277,7 +277,7 @@ getLocalDeviceInfoSync(): [DeviceInfo](#deviceinfo)
- 返回值：
| 名称 | 说明 |
| -------- | -------- |
| -------------------------------------- | --------- |
| Array&lt;[DeviceInfo](#deviceinfo)&gt; | 返回本地设备列表。 |
- 示例：
......@@ -296,7 +296,7 @@ getLocalDeviceInfo(callback:AsyncCallback&lt;DeviceInfo&gt;): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | --------- |
| callback | AsyncCallback&lt;[DeviceInfo](#deviceinfo)&gt; | 是 | 获取本地设备信息。 |
- 示例：
......@@ -318,7 +318,7 @@ getLocalDeviceInfo(): Promise&lt;DeviceInfo&gt;
- 返回值：
| 类型 | 说明 |
| -------- | -------- |
| ---------------------------------------- | --------------------- |
| Promise&lt;[DeviceInfo](#deviceinfo)&gt; | Promise实例，用于获取异步返回结果。 |
- 示例：
......@@ -340,7 +340,7 @@ startDeviceDiscovery(subscribeInfo: SubscribeInfo): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ------------- | ------------------------------- | ---- | ----- |
| subscribeInfo | [SubscribeInfo](#subscribeinfo) | 是 | 发现信息。 |
- 示例：
......@@ -369,7 +369,7 @@ stopDeviceDiscovery(subscribeId: number): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ------ | ---- | ----- |
| subscribeId | number | 是 | 发现标识。 |
- 示例：
......@@ -388,7 +388,7 @@ authenticateDevice(deviceInfo: DeviceInfo, authParam: AuthParam, callback: Async
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ---------------------------------------- | ---- | ------- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
| authParam | [AuthParam](#authparam) | 是 | 认证参数。 |
| callback | AsyncCallback<{ deviceId: string, pinToken ?: number }> | 是 | 认证结果回调。 |
......@@ -425,7 +425,7 @@ unAuthenticateDevice(deviceInfo: DeviceInfo): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ------------------------- | ---- | ----- |
| deviceInfo | [DeviceInfo](#deviceinfo) | 是 | 设备信息。 |
- 示例：
......@@ -444,7 +444,7 @@ verifyAuthInfo(authInfo: AuthInfo, callback: AsyncCallback<{deviceId: string, le
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ------- |
| authInfo | [AuthInfo](#authinfo) | 是 | 认证信息。 |
| authInfo | AsyncCallback<{ deviceId: string, level: number }> | 是 | 验证结果回调。 |
......@@ -475,7 +475,7 @@ on(type: 'deviceStateChange', callback: Callback&lt;{ action: DeviceStateChange
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备状态回调，固定为deviceStateChange。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要注册的设备状态回调，返回设备状态和设备信息。 |
......@@ -498,7 +498,7 @@ off(type: 'deviceStateChange', callback?: Callback&lt;{ action: DeviceStateChang
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 根据应用程序的包名取消注册设备状态回调。 |
| callback | Callback&lt;{&nbsp;action:&nbsp;[DeviceStateChangeAction](#devicestatechangeaction),&nbsp;device:&nbsp;[DeviceInfo](#deviceinfo)&nbsp;&nbsp;}&gt; | 是 | 指示要取消注册的设备状态回调，返回设备状态和设备信息。 |
......@@ -521,7 +521,7 @@ on(type: 'deviceFound', callback: Callback&lt;{ subscribeId: number, device: Dev
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | -------------------------- |
| type | string | 是 | 注册设备发现回调，以便在发现周边设备时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: DeviceInfo&nbsp;}&gt; | 是 | 注册设备发现的回调方法。 |
......@@ -543,7 +543,7 @@ off(type: 'deviceFound', callback?: Callback&lt;{ subscribeId: number, device: D
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | --------------------------- |
| type | string | 是 | 取消注册设备发现回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, device: [DeviceInfo](#deviceinfo)&nbsp;}&gt; | 是 | 指示要取消注册的设备发现回调，返回设备状态和设备信息。 |
......@@ -565,7 +565,7 @@ on(type: 'discoverFail', callback: Callback&lt;{ subscribeId: number, reason: nu
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 注册设备发现失败回调，以便在发现周边设备失败时通知应用程序。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 注册设备发现失败的回调方法。 |
......@@ -587,7 +587,7 @@ off(type: 'discoverFail', callback?: Callback&lt;{ subscribeId: number, reason:
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ----------------- |
| type | string | 是 | 取消注册设备发现失败回调。 |
| callback | Callback&lt;{&nbsp;subscribeId: number, reason: number&nbsp;}&gt; | 是 | 指示要取消注册的设备发现失败回调。 |
......@@ -610,7 +610,7 @@ on(type: 'serviceDie', callback: () =&gt; void): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 是 | 注册serviceDie的回调方法。 |
......@@ -633,7 +633,7 @@ off(type: 'serviceDie', callback?: () =&gt; void): void
- 参数：
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消注册serviceDie回调，以便在devicemanager服务异常终止时通知应用程序。 |
| callback | ()&nbsp;=&gt;&nbsp;void | 否 | 取消注册serviceDie的回调方法。 |
......
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @ 62e3640d
......@@ -10,7 +10,7 @@
## 导入模块
```
```js
import distributedMissionManager from '@ohos.distributedMissionManager'
```
......@@ -27,11 +27,11 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听设备信息。 |
| options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 注册监听设备信息。 |
| options | [MissionCallback](#missioncallback) | 是 | 注册的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：**
......@@ -71,16 +71,16 @@ registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback):
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| 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&
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 设备信息。 |
| callback | AsyncCallback&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;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------------------- | ---- | --------- |
| parameter | [MissionParameter](#missionparameter) | 是 | 同步信息。 |
| callback | AsyncCallback&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;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
| 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------- | ---- | --------- |
| parameter | [MissionDeviceInfo](#missiondeviceinfo) | 是 | 同步信息。 |
| callback | AsyncCallback&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,11 +314,11 @@ 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 |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接，返回设备ID，网络状态 |
......@@ -326,11 +326,11 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
表示同步时所需参数的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 是 | 表示设备ID。|
| ----------- | ------- | ---- | ---- | ----------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
| fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 |
| tag | number | 是 | 是 | 表示特定的标签。 |
......@@ -338,8 +338,8 @@ stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
表示注册监听时所需参数的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 是 | 表示设备ID。|
\ No newline at end of file
| -------- | ------ | ---- | ---- | ------- |
| deviceId | string | 是 | 是 | 表示设备ID。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-enterprise-device-manager.md
浏览文件 @ 62e3640d
......@@ -18,16 +18,14 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, callba
以异步方法根据给定的包名和类名激活设备管理员应用，使用Callback形式返回是否激活成功。
**需要权限：**
ohos.permission.MANAGE_ADMIN
**需要权限：** ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ------------------ |
| -------------- | ----------------------------------- | ---- | ------------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
......@@ -59,18 +57,14 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId
以异步方法根据给定的包名和类名激活设备管理员应用，使用Callback形式返回是否激活成功。
**需要权限：**
**需要权限：** ohos.permission.MANAGE_ADMIN
ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------------- |
| -------------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
......@@ -103,16 +97,14 @@ enableAdmin(admin: Want, enterpriseInfo: EnterpriseInfo, type: AdminType, userId
以异步方法根据给定的包名和类名激活设备管理员应用，使用Promise形式返回是否激活成功。
**需要权限：**
ohos.permission.MANAGE_ADMIN
**需要权限：** ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------------- |
| -------------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| type | [AdminType](#AdminType) | 是 | 激活的设备管理员类型 |
......@@ -149,16 +141,14 @@ disableAdmin(admin: Want, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名和类名将设备普通管理员应用去激活，使用Callback形式返回是否去激活成功。
**需要权限：**
ohos.permission.MANAGE_ADMIN
**需要权限：** ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ------------------- |
| -------- | ----------------------------------- | ---- | ------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
......@@ -184,18 +174,14 @@ disableAdmin(admin: Want, userId: number, callback: AsyncCallback\<boolean>): vo
以异步方法根据给定的包名和类名将设备普通管理员应用去激活，使用Callback形式返回是否去激活成功。
**需要权限：**
ohos.permission.MANAGE_ADMIN
**需要权限：** ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ---------------------------- |
| -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
......@@ -222,16 +208,14 @@ disableAdmin(admin: Want, userId?: number): Promise\<boolean>
以异步方法根据给定的包名和类名将设备普通管理员应用去激活，使用Promise形式返回是否去激活成功。
**需要权限：**
ohos.permission.MANAGE_ADMIN
**需要权限：** ohos.permission.MANAGE_ADMIN
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | --- | ---------------------------- |
| ------ | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 普通设备管理员应用 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
......@@ -261,13 +245,12 @@ disableSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名将设备超级管理员应用去激活，使用Callback形式返回是否去激活成功。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | --- | ------------------- |
| ---------- | ----------------------- | ---- | ------------------- |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否去激活成功 |
......@@ -290,13 +273,12 @@ disableSuperAdmin(bundleName: String): Promise\<boolean>
以异步方法根据给定的包名将设备超级管理员应用去激活，使用Promise形式返回是否去激活成功。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | --- | ------------ |
| ---------- | ------ | ---- | ------------ |
| bundleName | String | 是 | 超级设备管理员应用的包名 |
**返回值：**
......@@ -322,13 +304,12 @@ isAdminEnabled(admin: Want, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活，使用Callback形式返回是否处于激活状态。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | -------------------- |
| -------- | ----------------------------------- | ---- | -------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
......@@ -354,14 +335,12 @@ isAdminEnabled(admin: Want, userId: number, callback: AsyncCallback\<boolean>):
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活，使用Callback形式返回是否处于激活状态。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | --- | ---------------------------- |
| -------- | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 是 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
......@@ -388,13 +367,12 @@ isAdminEnabled(admin: Want, userId?: number): Promise\<boolean>
以异步方法根据给定的包名和类名判断设备管理员应用是否被激活，使用Promise形式返回是否处于激活状态。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ----------------------------------- | --- | ---------------------------- |
| ------ | ----------------------------------- | ---- | ---------------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| userId | number | 否 | 用户ID。默认值：调用方所在用户，取值范围：大于等于0。 |
......@@ -424,13 +402,12 @@ isSuperAdmin(bundleName: String, callback: AsyncCallback\<boolean>): void
以异步方法根据给定的包名判断设备超级管理员应用是否被激活，使用Callback形式返回是否处于激活状态。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------- | --- | -------------------- |
| ---------- | ----------------------- | ---- | -------------------- |
| bundleName | String | 是 | 设备管理员应用 |
| callback | AsyncCallback\<boolean> | 是 | callback方式返回是否处于激活状态 |
......@@ -453,13 +430,12 @@ isSuperAdmin(bundleName: String): Promise\<boolean>
以异步方法根据给定的包名判断设备超级管理员应用是否被激活，使用Promise形式返回是否处于激活状态。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数**：
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | --- | --------- |
| ---------- | ------ | ---- | --------- |
| bundleName | String | 是 | 超级设备管理员应用 |
**返回值：**
......@@ -485,13 +461,12 @@ getDeviceSettingsManager(callback: AsyncCallback&lt;DeviceSettingsManager&gt;):
获取DeviceSettingsManager对象，使用callback形式返回DeviceSettingsManager对象。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | --- | ----------------------------------- |
| -------- | --------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback<DeviceSettingsManager&gt; | 是 | callback方式返回DeviceSettingsManager对象 |
**示例：**
......@@ -522,8 +497,7 @@ getDeviceSettingsManager(): Promise&lt;DeviceSettingsManager&gt;
获取DeviceSettingsManager对象，使用Promise形式返回DeviceSettingsManager对象。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**返回值：**
......@@ -555,13 +529,12 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo, callback: AsyncCa
设置设备管理员应用的企业信息，使用callback形式返回是否设置成功。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ---------------------- |
| -------------- | ----------------------------------- | ---- | ---------------------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
| callback | AsyncCallback\<boolean&gt; | 是 | callback方式返回是否设置企业信息成功 |
......@@ -591,13 +564,12 @@ setEnterpriseInfo(admin: Want, enterpriseInfo: EnterpriseInfo): Promise&lt;boole
设置设备管理员应用的企业信息，使用Promise形式返回是否设置成功。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ----------------------------------- | --- | ------------ |
| -------------- | ----------------------------------- | ---- | ------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| enterpriseInfo | [EnterpriseInfo](#EnterpriseInfo) | 是 | 设备管理员应用的企业信息 |
......@@ -632,13 +604,12 @@ getEnterpriseInfo(admin: Want, callback: AsyncCallback&lt;EnterpriseInfo&gt;): v
获取设备管理员应用的企业信息，使用callback形式返回设备管理员应用的企业信息。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | --- | ------------------------ |
| -------- | ---------------------------------------- | ---- | ------------------------ |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
| callback | AsyncCallback&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | 是 | callback方式返回设备管理员应用的企业信息 |
......@@ -665,19 +636,18 @@ getEnterpriseInfo(admin: Want): Promise&lt;EnterpriseInfo&gt;
获取设备管理员应用的企业信息，使用Promise形式返回设备管理员应用的企业信息。
**系统能力：**
SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ----------------------------------- | --- | ------- |
| ----- | ----------------------------------- | ---- | ------- |
| admin | [Want](js-apis-application-Want.md) | 是 | 设备管理员应用 |
**返回值：**
| 类型 | 说明 |
| ------------------------------------------------ | ------------------------- |
| ---------------------------------------- | ------------------------- |
| Promise&lt;[EnterpriseInfo](#EnterpriseInfo)&gt; | Promise方式返回设备管理员应用的企业信息对象 |
**示例：**
......@@ -699,11 +669,10 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
设备管理员应用的企业信息
**系统能力：**
以下各项对应系统能力均为SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | ---- | ------ | --- | ----------------- |
| ----------- | ---- | ------ | ---- | ----------------- |
| name | 只读 | string | 是 | 表示设备管理员应用所属企业的名称。 |
| description | 只读 | string | 是 | 表示设备管理员应用所属企业的描述。 |
......@@ -711,8 +680,7 @@ enterpriseDeviceManager.getEnterpriseInfo(wantTemp).then((result) => {
设备管理员应用的管理员类型。
**系统能力：**
以下各项对应系统能力均为SystemCapability.Customization.EnterpriseDeviceManager
**系统能力：** SystemCapability.Customization.EnterpriseDeviceManager
| 名称 | 默认值 | 说明 |
| ----------------- | ---- | ----- |
......
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @ 62e3640d
......@@ -6,13 +6,13 @@ InputConsumer模块提供对按键事件的监听。
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口，三方应用不支持调用。
> - 本模块接口为系统接口。
## 导入模块
```
```js
import inputConsumer from '@ohos.multimodalInput.inputConsumer';
```
......@@ -23,21 +23,19 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback&lt;KeyOptions&gt;): v
开始监听组合按键事件, 当满足条件的组合按键输入事件发生时，将keyOptions回调到入参callback表示的回调函数上。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | -------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 监听输入事件类型，只支持“key”。 |
| keyOptions | [keyOptions](#keyoptions) | 是 | 组合键选项，用来指定组合键输入时应该符合的条件。 |
| callback | Callback&lt;KeyOptions&gt; | 是 | 回调函数。当满足条件的按键输入产生时，回调到此函数，以传入的KeyOptions为入参。 |
**示例：**
```
```js
let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) {
console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
......@@ -53,21 +51,19 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback&lt;KeyOptions&gt;):
停止监听组合按键事件。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 监听输入事件类型，只支持“key”。 |
| keyOptions | [keyOptions](#keyoptions) | 是 | 开始监听时传入的keyOptions。 |
| callback | Callback&lt;KeyOptions&gt; | 是 | 开始监听时与KeyOption一同传入的回调函数&nbsp;。 |
**示例：**
```
```js
let keyOptions = {preKeys: [], finalKey: 3, isFinalKeyDown: true, finalKeyDownDuration: 0}
let callback = function(keyOptions) {
console.info("preKeys: " + keyOptions.preKeys, "finalKey: " + keyOptions.finalKey,
......@@ -81,12 +77,10 @@ inputConsumer.off('key', keyOptions, callback);
组合键输入事件发生时，组合键满足的选项。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputConsumer
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| 参数 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------------ |
| preKeys | Array | 是 | 组合键前置按键集合，可为空，前置按键无顺序要求。 |
| finalKey | Number | 是 | 组合键最后按键，不能为空。 |
| isFinalKeyDown | boolean | 是 | 组合键最后按键是按下还是抬起，默认是按下。 |
......
zh-cn/application-dev/reference/apis/js-apis-inputdevice.md
浏览文件 @ 62e3640d
......@@ -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)=>{
输入设备的描述信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**：SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| -------------------- | -------------------------------------- | ---------------------------------------- |
......@@ -314,7 +314,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**：SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------- | ------ | --------------- |
......@@ -332,7 +332,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
输入设备的轴信息。
**系统能力**： 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**： SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------------------- | ------------------------- | -------- |
......@@ -348,7 +348,7 @@ inputDevice.getKeyboardType(1).then((ret)=>{
定义这个轴的输入源类型。比如鼠标设备可上报x轴事件，则x轴的源就是鼠标。
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**：SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 说明 |
| ----------- | ------ | ----------- |
......@@ -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)=>{
定义键盘输入设备的类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice
**系统能力**：SystemCapability.MultimodalInput.Input.InputDevice
| 名称 | 参数类型 | 值 | 说明 |
| ------------------- | ------ | ---- | --------- |
......
zh-cn/application-dev/reference/apis/js-apis-inputevent.md
浏览文件 @ 62e3640d
......@@ -2,7 +2,7 @@
InputEvent模块描述了设备上报的基本事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,10 +13,10 @@ import InputEvent from '@ohos.multimodalInput.inputEvent';
## InputEvent
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ---------- | ------ | ---- | ---- | -------------- |
| id | number | 是 | 否 | 由服务端生成全局唯一事件id |
| deviceId | number | 是 | 否 | 上报输入事件的设备id |
| actionTime | number | 是 | 否 | 输入事件的上报时间 |
......
zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md
浏览文件 @ 62e3640d
......@@ -6,7 +6,7 @@ InputEventClient模块提供了注入按键能力。
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口，三方应用不支持调用。
> - 本模块接口为系统接口。
## 导入模块
......@@ -23,8 +23,6 @@ injectEvent({KeyEvent: KeyEvent}): void
注入按键，KeyEvent为注入按键的描述信息。
此接口为系统接口。
**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
**参数：**
......@@ -48,11 +46,9 @@ let res = inputEventClient.injectEvent({KeyEvent: keyEvent});
## KeyEvent
注入按键的描述信息
此接口为系统接口。
注入按键的描述信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator
**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
| 参数 | 类型 | 必填 | 说明 |
| --------------- | ------- | ---- | --------- |
......
zh-cn/application-dev/reference/apis/js-apis-inputmonitor.md
浏览文件 @ 62e3640d
......@@ -2,10 +2,10 @@
InputMonitor模块提供了监听全局触摸事件的功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - 本模块接口均为系统接口，三方应用不支持调用。
> - 本模块接口均为系统接口。
## 导入模块
......@@ -16,26 +16,19 @@ import inputMonitor from '@ohos.multimodalInput.inputMonitor';
```
## 权限
ohos.permission.INPUT_MONITORING
## inputMonitor.on
on(type: "touch", receiver: TouchEventReceiver): void
开始监听全局触屏事件。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------- |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 是 | 触摸输入事件回调函数。 |
......@@ -53,8 +46,6 @@ on(type: "mouse", receiver: Callback&lt;MouseEvent&gt;): void
开始监听全局鼠标事件。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
......@@ -62,7 +53,7 @@ on(type: "mouse", receiver: Callback&lt;MouseEvent&gt;): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------- |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 |
| receiver | Callback&lt;MouseEvent&gt; | 是 | 鼠标输入事件回调函数。 |
......@@ -82,15 +73,13 @@ off(type: "touch", receiver?: TouchEventReceiver): void
停止监听全局触屏事件。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | ------------------------------- |
| -------- | ---------------------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“touch”。 |
| receiver | [TouchEventReceiver](#toucheventreceiver) | 否 | 触摸输入事件回调函数。 |
......@@ -104,8 +93,6 @@ off(type: "mouse", receiver?: Callback&lt;MouseEvent&gt;): void
停止监听全局鼠标事件。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
......@@ -113,7 +100,7 @@ off(type: "mouse", receiver?: Callback&lt;MouseEvent&gt;): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| -------- | -------------------------- | ---- | ------------------------------- |
| -------- | -------------------------- | ---- | ------------------- |
| type | string | 是 | 监听输入事件类型，取值“mouse”。 |
| receiver | Callback&lt;MouseEvent&gt; | 否 | 鼠标输入事件回调函数。 |
......@@ -129,7 +116,7 @@ inputMonitor.off("mouse");
触摸输入事件的回调函数。如果返回true，则触摸输入被监听器消耗，系统将执行关闭动作。
此接口为系统接口。
**需要权限：** ohos.permission.INPUT_MONITORING
**系统能力：** SystemCapability.MultimodalInput.Input.InputMonitor
......@@ -140,7 +127,7 @@ inputMonitor.off("mouse");
**返回值：**
| 类型 | 说明 |
| ------- | -------------------------------------- |
| ------- | ---------------------------------------- |
| Boolean | 返回true表示触摸输入事件被监听器消费，false表示触摸输入事件未被监听器消费。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-intl.md
浏览文件 @ 62e3640d
......@@ -3,7 +3,7 @@
本模块提供提供基础的应用国际化能力，包括时间日期格式化、数字格式化、排序等，相关接口在ECMA 402标准中定义。
[I18N模块](js-apis-i18n.md)提供其他非ECMA 402定义的国际化接口，与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - Intl模块包含国际化能力基础接口（在ECMA 402中定义），包括时间日期格式化、数字格式化、排序等，国际化增强能力请参考[I18N模块](js-apis-i18n.md)。
......@@ -11,7 +11,7 @@
## 导入模块
```
```js
import Intl from '@ohos.intl';
```
......@@ -46,7 +46,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var locale = new Intl.Locale();
```
......@@ -66,7 +66,7 @@ constructor(locale: string, options?: LocaleOptions)
| options | LocaleOptions | 否 | 用于创建区域对象的选项。 |
**示例：**
```
```js
var locale = new Intl.Locale("zh-CN");
```
......@@ -85,7 +85,7 @@ toString(): string
| string | 字符串形式的区域信息。 |
**示例：**
```
```js
var locale = new Intl.Locale("zh-CN");
locale.toString();
```
......@@ -105,7 +105,7 @@ maximize(): Locale
| [Locale](#locale) | 最大化后的区域对象。 |
**示例：**
```
```js
var locale = new Intl.Locale("zh-CN");
locale.maximize();
```
......@@ -125,7 +125,7 @@ minimize(): Locale
| [Locale](#locale) | 最小化后的区域对象。 |
**示例：**
```
```js
var locale = new Intl.Locale("zh-CN");
locale.minimize();
```
......@@ -135,7 +135,7 @@ minimize(): Locale
表示区域初始化选项。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
......@@ -159,7 +159,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var datefmt= new Intl.DateTimeFormat();
```
......@@ -179,13 +179,13 @@ constructor(locale: string | Array&lt;string&gt;, options?: DateTimeOptions)
| options | [DateTimeOptions](#datetimeoptions) | 否 | 用于创建时间日期格式化的选项。 |
**示例：**
```
```js
var datefmt= new Intl.DateTimeFormat("zh-CN", { dateStyle: 'full', timeStyle: 'medium' });
```
**示例：**
```
```js
var datefmt= new Intl.DateTimeFormat(["ban", "zh"], { dateStyle: 'full', timeStyle: 'medium' });
```
......@@ -209,7 +209,7 @@ format(date: Date): string
| string | 格式化后的时间日期字符串 |
**示例：**
```
```js
var date = new Date(2021, 11, 17, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.format(date);
......@@ -236,7 +236,7 @@ formatRange(startDate: Date, endDate: Date): string
| string | 格式化后的时间日期段字符串。 |
**示例：**
```
```js
var startDate = new Date(2021, 11, 17, 3, 24, 0);
var endDate = new Date(2021, 11, 18, 3, 24, 0);
var datefmt = new Intl.DateTimeFormat("en-GB");
......@@ -258,7 +258,7 @@ resolvedOptions(): DateTimeOptions
| [DateTimeOptions](#datetimeoptions) | DateTimeFormat&nbsp;对象的格式化选项。 |
**示例：**
```
```js
var datefmt = new Intl.DateTimeFormat("en-GB");
datefmt.resolvedOptions();
```
......@@ -268,7 +268,7 @@ resolvedOptions(): DateTimeOptions
表示时间日期格式化选项。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------- | ---- | ---- | ---------------------------------------- |
......@@ -305,7 +305,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var numfmt = new Intl.NumberFormat();
```
......@@ -325,7 +325,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: NumberOptions)
| options | [NumberOptions](#numberoptions) | 否 | 用于创建数字格式化的选项。 |
**示例：**
```
```js
var numfmt = new Intl.NumberFormat("en-GB", {style:'decimal', notation:"scientific"});
```
......@@ -350,7 +350,7 @@ format(number: number): string;
**示例：**
```
```js
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.format(1223);
```
......@@ -371,7 +371,7 @@ resolvedOptions(): NumberOptions
**示例：**
```
```js
var numfmt = new Intl.NumberFormat(["en-GB", "zh"], {style:'decimal', notation:"scientific"});
numfmt.resolvedOptions();
```
......@@ -418,7 +418,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var collator = new Intl.Collator();
```
......@@ -439,7 +439,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: CollatorOptions)
| options | [CollatorOptions](#collatoroptions) | 否 | 用于创建排序对象的选项。 |
**示例：**
```
```js
var collator = new Intl.Collator("zh-CN", {localeMatcher: "lookup", usage: "sort"});
```
......@@ -464,7 +464,7 @@ compare(first: string, second: string): number
| number | 比较结果。当number为负数，表示first排序在second之前；当number为0，表示first与second排序相同；当number为正数，表示first排序在second之后。 |
**示例：**
```
```js
var collator = new Intl.Collator("zh-Hans");
collator.compare("first", "second");
```
......@@ -484,17 +484,17 @@ resolvedOptions(): CollatorOptions
| [CollatorOptions](#collatoroptions) | 返回的Collator对象的属性。 |
**示例：**
```
```js
var collator = new Intl.Collator("zh-Hans");
var options = collator.resolvedOptions();
```
## CollatorOptions<sup>8+</sup><a name=collatoroptions></a>
## CollatorOptions<sup>8+</sup>
表示Collator可设置的属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ----------------- | ------- | ---- | ---- | ---------------------------------------- |
......@@ -519,7 +519,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var pluralRules = new Intl.PluralRules();
```
......@@ -539,7 +539,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: PluralRulesOptions)
| options | [PluralRulesOptions](#pluralrulesoptions) | 否 | 用于创建单复数对象的选项。 |
**示例：**
```
```js
var pluralRules= new Intl.PluraRules("zh-CN", {"localeMatcher": "lookup", "type": "cardinal"});
```
......@@ -563,17 +563,17 @@ select(n: number): string
| string | 单复数类别，取值包括："zero"，"one"，"two",&nbsp;"few",&nbsp;"many",&nbsp;"others"。 |
**示例：**
```
```js
var pluralRules = new Intl.PluralRules("zh-Hans");
pluralRules.select(1);
```
## PluralRulesOptions<sup>8+</sup><a name=pluralrulesoptions></a>
## PluralRulesOptions<sup>8+</sup>
表示PluralRules对象可设置的属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------------------ | ------ | ---- | ---- | ---------------------------------------- |
......@@ -598,7 +598,7 @@ constructor()
**系统能力**：SystemCapability.Global.I18n
**示例：**
```
```js
var relativetimefmt = new Intl.RelativeTimeFormat();
```
......@@ -618,7 +618,7 @@ constructor(locale: string | Array&lt;string&gt;, options?: RelativeTimeFormatIn
| options | [RelativeTimeFormatInputOptions](#relativetimeformatinputoptions) | 否 | 用于创建相对时间格式化对象的选项。 |
**示例：**
```
```js
var relativeTimeFormat = new Intl.RelativeTimeFormat("zh-CN", {"localeMatcher": "lookup", "numeric": "always", "style": "long"});
```
......@@ -643,7 +643,7 @@ format(value: number, unit: string): string
| string | 格式化后的相对时间。 |
**示例：**
```
```js
var relativetimefmt = new Intl.RelativeTimeFormat("zh-CN");
relativetimefmt.format(3, "quarter")
```
......@@ -669,7 +669,7 @@ formatToParts(value: number, unit: string): Array&lt;object&gt;
| Array&lt;object&gt; | 返回可用于自定义区域设置格式的相对时间格式的对象数组。 |
**示例：**
```
```js
var relativetimefmt = new Intl.RelativeTimeFormat("en", {"numeric": "auto"});
var parts = relativetimefmt.format(10, "seconds");
```
......@@ -689,17 +689,17 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
| [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | RelativeTimeFormat&nbsp;对象的格式化选项。 |
**示例：**
```
```js
var relativetimefmt= new Intl.RelativeTimeFormat("en-GB");
relativetimefmt.resolvedOptions();
```
## RelativeTimeFormatInputOptions<sup>8+</sup><a name=relativetimeformatinputoptions></a>
## RelativeTimeFormatInputOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
......@@ -708,11 +708,11 @@ resolvedOptions(): RelativeTimeFormatResolvedOptions
| style | string | 是 | 是 | 国际化消息的长度，取值包括："long",&nbsp;"short",&nbsp;"narrow"。 |
## RelativeTimeFormatResolvedOptions<sup>8+</sup><a name=relativetimeformatresolvedoptions></a>
## RelativeTimeFormatResolvedOptions<sup>8+</sup>
表示RelativeTimeFormat对象可设置的属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| --------------- | ------ | ---- | ---- | ---------------------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-keycode.md
浏览文件 @ 62e3640d
......@@ -2,7 +2,7 @@
KeyCode模块提供了按键类设备的键值。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,10 +13,10 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode'
## KeyCode
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| -------------------------------- | ------ | ---- | ---- | --------------------------- |
| KEYCODE_FN | number | 是 | 否 | 功能（Fn）键 |
| KEYCODE_UNKNOWN | number | 是 | 否 | 未知按键 |
| KEYCODE_HOME | number | 是 | 否 | 按键Home |
......@@ -88,7 +88,7 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode'
| KEYCODE_SPACE | number | 是 | 否 | 空格键 |
| KEYCODE_SYM | number | 是 | 否 | 符号修改器按键 |
| KEYCODE_EXPLORER | number | 是 | 否 | 浏览器功能键，此键用于启动浏览器应用程序。 |
| KEYCODE_ENVELOPE | number | 是 | 否 | 电子邮件功能键，此键用于启动电子邮件应用程序。|
| KEYCODE_ENVELOPE | number | 是 | 否 | 电子邮件功能键，此键用于启动电子邮件应用程序。 |
| KEYCODE_ENTER | number | 是 | 否 | 回车键 |
| KEYCODE_DEL | number | 是 | 否 | 退格键 |
| KEYCODE_GRAVE | number | 是 | 否 | 按键'`' |
......@@ -329,11 +329,11 @@ import {KeyCode} from '@ohos.multimodalInput.keyCode'
| KEYCODE_SPORT | number | 是 | 否 | 运动按键 |
| KEYCODE_SHOP | number | 是 | 否 | 商城键 |
| KEYCODE_ALTERASE | number | 是 | 否 | 交替键 |
| KEYCODE_SWITCHVIDEOMODE | number | 是 | 否 | 在可用视频之间循环输出（监视器/LCD/TV输出/等）|
| KEYCODE_SWITCHVIDEOMODE | number | 是 | 否 | 在可用视频之间循环输出（监视器/LCD/TV输出/等） |
| KEYCODE_BATTERY | number | 是 | 否 | 电池按键 |
| KEYCODE_BLUETOOTH | number | 是 | 否 | 蓝牙按键 |
| KEYCODE_WLAN | number | 是 | 否 | 无线局域网 |
| KEYCODE_UWB | number | 是 | 否 | 超宽带（UWB）|
| KEYCODE_UWB | number | 是 | 否 | 超宽带（UWB） |
| KEYCODE_WWAN_WIMAX | number | 是 | 否 | WWAN WiMAX按键 |
| KEYCODE_RFKILL | number | 是 | 否 | 控制所有收音机的键 |
| KEYCODE_CHANNEL | number | 是 | 否 | 向上频道键 |
......
zh-cn/application-dev/reference/apis/js-apis-keyevent.md
浏览文件 @ 62e3640d
......@@ -2,7 +2,8 @@
KeyEvent模块提供了设备可以上报的按键事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,30 +14,30 @@ import {Action,Key,KeyEvent} from '@ohos.multimodalInput.keyEvent';
## Action
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ---- | ---- |
| CANCEL | number | 是 | 否 | 取消 |
| DOWN | number | 是 | 否 | 按下按钮 |
| UP | number | 是 | 否 | 抬起按钮 |
## Key
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | ------- | ---- | ---- | ------ |
| code | KeyCode | 是 | 否 | 按键码 |
| pressedTime | number | 是 | 否 | 按下时间 |
| deviceId | number | 是 | 否 | 按键所属设备 |
## KeyEvent
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | ------- | ---- | ---- | -------------------- |
| action | Action | 是 | 否 | 按键动作 |
| key | Key | 是 | 否 | 当前发生变化的按键 |
| unicodeChar | number | 是 | 否 | 按键对应的uniCode字符 |
......
zh-cn/application-dev/reference/apis/js-apis-mediaquery.md
浏览文件 @ 62e3640d
......@@ -3,6 +3,7 @@
提供根据不同媒体类型定义不同的样式。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
......@@ -118,7 +119,7 @@ off(type: 'change', callback?: Callback&lt;MediaQueryResult&gt;): void
### 示例
```js
```ts
import mediaquery from '@ohos.mediaquery'
let portraitFunc = null
......
zh-cn/application-dev/reference/apis/js-apis-mouseevent.md
浏览文件 @ 62e3640d
......@@ -2,7 +2,7 @@
设备上报的鼠标事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,10 +13,10 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## Action
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | ------ | ---- | ---- | ---------- |
| CANCEL | number | 是 | 否 | 取消 |
| MOVE | number | 是 | 否 | 鼠标移动 |
| BUTTON_DOWN | number | 是 | 否 | 鼠标按钮按下 |
......@@ -28,10 +28,10 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## Button
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ------- | ------ | ---- | ---- | ----- |
| LEFT | number | 是 | 否 | 鼠标左键 |
| MIDDLE | number | 是 | 否 | 鼠标中键 |
| RIGHT | number | 是 | 否 | 鼠标右键 |
......@@ -43,10 +43,10 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## Axis
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------------- | ------ | ---- | ---- | ----- |
| SCROLL_VERTICAL | number | 是 | 否 | 垂直滚动轴 |
| SCROLL_HORIZONTAL | number | 是 | 否 | 水平滚动轴 |
| PINCH | number | 是 | 否 | 捏合轴 |
......@@ -54,20 +54,20 @@ import {Action,Button,Axis,AxisValue,MouseEvent} from '@ohos.multimodalInput.mou
## AxisValue
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----- | ------ | ---- | ---- | ---- |
| axis | Axis | 是 | 否 | 轴类型 |
| value | number | 是 | 否 | 轴的值 |
## MouseEvent
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| -------------- | ----------- | ---- | ---- | ---------------------------------------- |
| action | Action | 是 | 否 | 鼠标事件动作 |
| screenX | number | 是 | 否 | 鼠标光标在屏幕中的x坐标 |
| screenY | number | 是 | 否 | 鼠标光标在屏幕中的y坐标 |
......
zh-cn/application-dev/reference/apis/js-apis-prompt.md
浏览文件 @ 62e3640d
......@@ -8,7 +8,7 @@
## 导入模块
```
```js
import prompt from '@ohos.prompt'
```
......@@ -26,15 +26,11 @@ showToast(options: ShowToastOptions): void
| options | [ShowToastOptions](#showtoastoptions) | 是 | 文本弹窗选项。 |
**示例：**
```
export default {
showToast() {
prompt.showToast({
```js
prompt.showToast({
message: 'Message Info',
duration: 2000,
});
}
}
});
```
## ShowToastOptions
......@@ -43,10 +39,10 @@ showToast(options: ShowToastOptions): void
**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------- | ---- | ---------------------------------------- |
| -------- | ---------------------------------------- | ------ | ---------------------------------------- |
| message | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 显示的文本信息。 |
| duration | number | 否 | 默认值1500ms，建议区间：1500ms-10000ms，若小于1500ms则取默认值。 |
| bottom | string | number | 否 | 设置弹窗边框距离屏幕底部的位置。 |
| bottom | string | number | 否 |
## prompt.showDialog
......@@ -69,10 +65,8 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;
**示例：**
```
export default {
showDialog() {
prompt.showDialog({
```js
prompt.showDialog({
title: 'Title Info',
message: 'Message Info',
buttons: [
......@@ -85,15 +79,13 @@ showDialog(options: ShowDialogOptions): Promise&lt;ShowDialogSuccessResponse&gt;
color: '#000000',
}
],
})
})
.then(data => {
console.info('showDialog success, click button: ' + data.index);
})
.catch(err => {
console.info('showDialog error: ' + err);
})
}
}
```
## prompt.showDialog
......@@ -112,17 +104,8 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
| callback | AsyncCallback&lt;[ShowDialogSuccessResponse](#showdialogsuccessresponse)&gt; | 是 | 对话框响应结果回调。 |
**示例：**
```
export default {
callback(err, data) {
if(err) {
console.info('showDialog err: ' + err);
return;
}
console.info('showDialog success callback, click button: ' + data.index);
},
showDialog() {
prompt.showDialog({
```js
prompt.showDialog({
title: 'showDialog Title Info',
message: 'Message Info',
buttons: [
......@@ -135,9 +118,13 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
color: '#000000',
}
]
}, this.callback);
}
}, (err, data) => {
if (err) {
console.info('showDialog err: ' + err);
return;
}
console.info('showDialog success callback, click button: ' + data.index);
});
```
## ShowDialogOptions
......@@ -147,7 +134,7 @@ showDialog(options: ShowDialogOptions, callback: AsyncCallback&lt;ShowDialogSucc
**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- |
| ------- | ---------------------------------------- | ---- | ---------------------------------------- |
| title | 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。 |
......@@ -179,17 +166,8 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
**示例：**
```
export default {
callback(err, data) {
if(err) {
console.info('showActionMenu err: ' + err);
return;
}
console.info('showActionMenu success callback, click button: ' + data.index);
},
showActionMenu() {
prompt.showActionMenu({
```js
prompt.showActionMenu({
title: 'Title Info',
buttons: [
{
......@@ -201,9 +179,13 @@ showActionMenu(options: ActionMenuOptions, callback: AsyncCallback&lt;ActionMenu
color: '#000000',
},
]
}, this.callback)
}
}, (err, data) => {
if (err) {
console.info('showActionMenu err: ' + err);
return;
}
console.info('showActionMenu success callback, click button: ' + data.index);
})
```
## prompt.showActionMenu
......@@ -225,10 +207,8 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
| Promise&lt;[ActionMenuSuccessResponse](#actionmenusuccessresponse)&gt; | 菜单响应结果。 |
**示例：**
```
export default {
showActionMenu() {
prompt.showActionMenu({
```js
prompt.showActionMenu({
title: 'showActionMenu Title Info',
buttons: [
{
......@@ -240,24 +220,22 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
color: '#000000',
},
]
})
})
.then(data => {
console.info('showActionMenu success, click button: ' + data.index);
})
.catch(err => {
console.info('showActionMenu error: ' + err);
})
}
}
```
## ActionMenuOptions
操作菜单的选项。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
**系统能力：** SystemCapability.ArkUI.ArkUI.Full。
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------------------------- |
| ------- | ---------------------------------------- | ---- | ---------------------------------------- |
| 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个按钮时弹窗不显示。 |
......@@ -265,7 +243,7 @@ showActionMenu(options: ActionMenuOptions): Promise&lt;ActionMenuSuccessResponse
操作菜单的响应结果。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full。
**系统能力：** SystemCapability.ArkUI.ArkUI.Full
| 名称 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ------------------------ |
......@@ -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> | 是 | 按钮文本内容。 |
| color | string\| [Resource](../../ui/ts-types.md#resource类型)<sup>9+</sup> | 是 | 按钮文本颜色。 |
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @ 62e3640d
......@@ -2,7 +2,8 @@
设备上报的触屏事件。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -13,10 +14,10 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## Action
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ------ | ------ | ---- | ---- | ---- |
| CANCEL | number | 是 | 否 | 触摸取消 |
| DOWN | number | 是 | 否 | 触摸按下 |
| MOVE | number | 是 | 否 | 触摸移动 |
......@@ -24,10 +25,10 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## ToolType
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | ------ | ---- | ---- | ---- |
| FINGER | number | 是 | 否 | 手指 |
| PEN | number | 是 | 否 | 笔 |
| RUBBER | number | 是 | 否 | 橡皮擦 |
......@@ -39,20 +40,20 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## SourceType
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ------------ | ------ | ---- | ---- | ---- |
| TOUCH_SCREEN | number | 是 | 否 | 触摸屏 |
| PEN | number | 是 | 否 | 手写笔 |
| TOUCH_PAD | number | 是 | 否 | 触摸板 |
## Touch
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ----------- | ------ | ---- | ---- | ----------------------------------- |
| id | number | 是 | 否 | 指针标识 |
| pressedTime | number | 是 | 否 | 按下时的时间戳 |
| screenX | number | 是 | 否 | 触摸位置所属的屏幕x坐标 |
......@@ -74,10 +75,10 @@ import {Action,ToolType,SourceType,Touch,TouchEvent} from '@ohos.multimodalInput
## TouchEvent
**系统能力**：以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.Core
**系统能力**：SystemCapability.MultimodalInput.Input.Core
| 名称 | 参数类型 | 可读 | 可写 | 描述 |
| -------- | -------- | -------- | -------- | -------- |
| ---------- | ---------- | ---- | ---- | --------- |
| action | Action | 是 | 否 | 触摸动作 |
| touch | Touch | 是 | 否 | 当前触摸点 |
| touches | Touch[] | 是 | 否 | 所有触摸点 |
......
zh-cn/application-dev/reference/apis/js-apis-update.md
浏览文件 @ 62e3640d
......@@ -41,7 +41,7 @@ getOnlineUpdater(upgradeInfo: UpgradeInfo): Updater
**示例：**
```
```ts
try {
var upgradeInfo = {
upgradeApp: "com.ohos.ota.updateclient",
......@@ -73,7 +73,7 @@ getRestorer(): Restorer
**示例：**
```
```ts
try {
let restorer = update.getRestorer();
} catch(error) {
......@@ -97,7 +97,7 @@ getLocalUpdater(): LocalUpdater
**示例：**
```
```ts
try {
let localUpdater = update.getLocalUpdater();
} catch(error) {
......@@ -125,7 +125,7 @@ checkNewVersion(callback: AsyncCallback\<CheckResult>): void
**示例：**
```
```ts
updater.checkNewVersion((err, result) => {
console.log(`checkNewVersion isExistNewVersion ${result?.isExistNewVersion}`);
});
......@@ -149,7 +149,7 @@ checkNewVersion(): Promise\<CheckResult>
**示例:**
```
```ts
updater.checkNewVersion().then(result => {
console.log(`checkNewVersion isExistNewVersion: ${result.isExistNewVersion}`);
// 版本摘要信息
......@@ -177,7 +177,7 @@ getNewVersionInfo(callback: AsyncCallback\<NewVersionInfo>): void
**示例：**
```
```ts
updater.getNewVersionInfo((err, info) => {
console.log(`info displayVersion = ${info?.versionComponents[0].displayVersion}`);
console.log(`info innerVersion = ${info?.versionComponents[0].innerVersion}`);
......@@ -202,7 +202,7 @@ getNewVersionInfo(): Promise\<NewVersionInfo>
**示例：**
```
```ts
updater.getNewVersionInfo().then(info => {
console.log(`info displayVersion = ${info.versionComponents[0].displayVersion}`);
console.log(`info innerVersion = ${info.versionComponents[0].innerVersion}`);
......@@ -231,7 +231,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -274,7 +274,7 @@ getNewVersionDescription(versionDigestInfo: VersionDigestInfo, descriptionOption
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -311,7 +311,7 @@ getCurrentVersionInfo(callback: AsyncCallback\<CurrentVersionInfo>): void
**示例：**
```
```ts
updater.getCurrentVersionInfo((err, info) => {
console.log(`info osVersion = ${info?.osVersion}`);
console.log(`info deviceName = ${info?.deviceName}`);
......@@ -337,7 +337,7 @@ getCurrentVersionInfo(): Promise\<CurrentVersionInfo>
**示例：**
```
```ts
updater.getCurrentVersionInfo().then(info => {
console.log(`info osVersion = ${info.osVersion}`);
console.log(`info deviceName = ${info.deviceName}`);
......@@ -366,7 +366,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions, callback: A
**示例：**
```
```ts
// 描述文件选项
var descriptionOptions = {
format: DescriptionFormat.STANDARD, // 标准格式
......@@ -403,7 +403,7 @@ getCurrentVersionDescription(descriptionOptions: DescriptionOptions): Promise\<A
**示例：**
```
```ts
// 描述文件选项
var descriptionOptions = {
format: DescriptionFormat.STANDARD, // 标准格式
......@@ -435,7 +435,7 @@ getTaskInfo(callback: AsyncCallback\<TaskInfo>): void
**示例：**
```
```ts
updater.getTaskInfo((err, info) => {
console.log(`getTaskInfo isexistTask= ${info?.existTask}`);
});
......@@ -459,7 +459,7 @@ getTaskInfo(): Promise\<TaskInfo>
**示例：**
```
```ts
updater.getTaskInfo().then(info => {
console.log(`getTaskInfo isexistTask= ${info.existTask}`);
}).catch(err => {
......@@ -487,7 +487,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions,
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -528,7 +528,7 @@ download(versionDigestInfo: VersionDigestInfo, downloadOptions: DownloadOptions)
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -566,7 +566,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -606,7 +606,7 @@ resumeDownload(versionDigestInfo: VersionDigestInfo, resumeDownloadOptions: Resu
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -643,7 +643,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -683,7 +683,7 @@ pauseDownload(versionDigestInfo: VersionDigestInfo, pauseDownloadOptions: PauseD
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -720,7 +720,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions, ca
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -760,7 +760,7 @@ upgrade(versionDigestInfo: VersionDigestInfo, upgradeOptions: UpgradeOptions): P
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -797,7 +797,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions, cal
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -837,7 +837,7 @@ clearError(versionDigestInfo: VersionDigestInfo, clearOptions: ClearOptions): Pr
**示例：**
```
```ts
// 版本摘要信息
var versionDigestInfo = {
versionDigest: "versionDigest" // 检测结果中的版本摘要信息
......@@ -872,7 +872,7 @@ getUpgradePolicy(callback: AsyncCallback\<UpgradePolicy>): void
**示例：**
```
```ts
updater.getUpgradePolicy((err, policy) => {
console.log(`policy downloadStrategy = ${policy?.downloadStrategy}`);
console.log(`policy autoUpgradeStrategy = ${policy?.autoUpgradeStrategy}`);
......@@ -897,7 +897,7 @@ getUpgradePolicy(): Promise\<UpgradePolicy>
**示例：**
```
```ts
updater.getUpgradePolicy().then(policy => {
console.log(`policy downloadStrategy = ${policy.downloadStrategy}`);
console.log(`policy autoUpgradeStrategy = ${policy.autoUpgradeStrategy}`);
......@@ -925,7 +925,7 @@ setUpgradePolicy(policy: UpgradePolicy, callback: AsyncCallback\<void>): void
**示例：**
```
```ts
let policy = {
downloadStrategy: false,
autoUpgradeStrategy: false,
......@@ -960,7 +960,7 @@ setUpgradePolicy(policy: UpgradePolicy): Promise\<void>
**示例：**
```
```ts
let policy = {
downloadStrategy: false,
autoUpgradeStrategy: false,
......@@ -991,7 +991,7 @@ terminateUpgrade(callback: AsyncCallback\<void>): void
**示例：**
```
```ts
updater.terminateUpgrade((err) => {
console.log(`terminateUpgrade error ${JSON.stringify(err)}`);
});
......@@ -1015,7 +1015,7 @@ terminateUpgrade(): Promise\<void>
**示例：**
```
```ts
updater.terminateUpgrade().then(() => {
console.log(`terminateUpgrade success`);
}).catch(err => {
......@@ -1040,7 +1040,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**示例：**
```
```ts
var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: ""
......@@ -1067,7 +1067,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**示例：**
```
```ts
var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: ""
......@@ -1098,7 +1098,7 @@ factoryReset(callback: AsyncCallback\<void>): void
**示例：**
```
```ts
restorer.factoryReset((err) => {
console.log(`factoryReset error ${JSON.stringify(err)}`);
});
......@@ -1122,7 +1122,7 @@ factoryReset(): Promise\<void>
**示例:**
```
```ts
restorer.factoryReset().then(() => {
console.log(`factoryReset success`);
}).catch(err => {
......@@ -1152,7 +1152,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string, callback: Asyn
**示例：**
```
```ts
var upgradeFile = {
fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径
......@@ -1188,7 +1188,7 @@ verifyUpgradePackage(upgradeFile: UpgradeFile, certsFile: string): Promise\<void
**示例:**
```
```ts
var upgradeFile = {
fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径
......@@ -1218,7 +1218,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>, callback: Asyn
**示例：**
```
```ts
var upgradeFiles = [{
fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径
......@@ -1247,7 +1247,7 @@ applyNewVersion(upgradeFiles: Array<[UpgradeFile](#upgradefile)>): Promise\<void
**示例:**
```
```ts
var upgradeFiles = [{
fileType: update.ComponentType.OTA, // OTA包
filePath: "path" // 本地升级包路径
......@@ -1275,7 +1275,7 @@ on(eventClassifyInfo: EventClassifyInfo, taskCallback: UpgradeTaskCallback): voi
**示例：**
```
```ts
var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: ""
......@@ -1304,7 +1304,7 @@ off(eventClassifyInfo: EventClassifyInfo, taskCallback?: UpgradeTaskCallback): v
**示例：**
```
```ts
var eventClassifyInfo = {
eventClassify: update.EventClassify.TASK, // 订阅升级更新事件
extraInfo: ""
......
zh-cn/application-dev/reference/apis/js-apis-workScheduler.md
浏览文件 @ 62e3640d
......@@ -4,13 +4,13 @@
开发者在开发应用时，通过调用延迟任务注册接口，注册对实时性要求不高的延迟任务，该任务默认由系统安排，在系统空闲时根据性能、功耗、热等情况进行调度执行。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
```js
import workScheduler from '@ohos.workScheduler'
```
......@@ -35,7 +35,7 @@ startWork(work: WorkInfo): boolean
**示例**：
```
```js
let workInfo = {
workId: 1,
batteryLevel:50,
......@@ -71,7 +71,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): boolean
**示例**：
```
```js
let workInfo = {
workId: 1,
batteryLevel:50,
......@@ -101,7 +101,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<WorkInfo>): void
**示例**：
```
```js
workScheduler.getWorkStatus(50, (err, res) => {
if (err) {
console.info('workschedulerLog getWorkStatus failed, because:' + err.code);
......@@ -134,7 +134,7 @@ getWorkStatus(workId: number): Promise\<WorkInfo>
**示例**：
```
```js
workScheduler.getWorkStatus(50).then((res) => {
for (let item in res) {
console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]);
......@@ -165,7 +165,7 @@ obtainAllWorks(callback : AsyncCallback\<void>): Array\<WorkInfo>
**示例**：
```
```js
workScheduler.obtainAllWorks((err, res) =>{
if (err) {
console.info('workschedulerLog obtainAllWorks failed, because:' + err.code);
......@@ -190,7 +190,7 @@ obtainAllWorks(): Promise<Array\<WorkInfo>>
**示例**：
```
```js
workScheduler.obtainAllWorks().then((res) => {
console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res));
}).catch((err) => {
......@@ -207,7 +207,7 @@ stopAndClearWorks(): boolean
**示例**：
```
```js
let res = workScheduler.stopAndClearWorks();
console.info("workschedulerLog res:" + res);
```
......@@ -234,7 +234,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\<void>): boolean
**示例**：
```
```js
workScheduler.isLastWorkTimeOut(500, (err, res) =>{
if (err) {
console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code);
......@@ -265,7 +265,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
**示例**：
```
```js
workScheduler.isLastWorkTimeOut(500)
.then(res => {
console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res);
......@@ -278,10 +278,10 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## WorkInfo
提供工作的具体信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | --------------------------------- | ---- | -------------------------------- |
| --------------- | --------------------------------- | ---- | ---------------- |
| workId | number | 是 | 当前工作的ID |
| bundleName | string | 是 | 延迟任务包名 |
| abilityName | string | 是 | 延迟任务回调通知的组件名（必填） |
......@@ -301,7 +301,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## NetworkType
触发工作的网络类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| ---------------------- | ---- | ----------------------- |
......@@ -315,7 +315,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## ChargingType
触发工作的充电类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| ------------------------- | ---- | -------------------- |
......@@ -327,7 +327,7 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## BatteryStatus
触发工作的电池状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
| 名称 | 默认值 | 说明 |
| -------------------------- | ---- | -------------------------- |
......@@ -338,10 +338,10 @@ isLastWorkTimeOut(workId: number): Promise\<boolean>
## StorageRequest
触发工作的存储状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler
**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler
|名称 |默认值 |说明|
| -------- | -------- | -------- |
|STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。
|STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。
|STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。
\ No newline at end of file
| 名称 | 默认值 | 说明 |
| ------------------------- | ---- | ------------------------------ |
| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 |
| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 |
| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 |
\ No newline at end of file
zh-cn/application-dev/website.md
浏览文件 @ 62e3640d
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或