Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 0c252a6a 编写于 作者: H HelloCrease
浏览文件
操作

update docs 

Signed-off-by: NHelloCrease <lian15@huawei.com>
上级 82850e67
显示空白变更内容
内联 并排
Showing with 1313 addition and 1387 deletion
zh-cn/application-dev/reference/Readme-CN.md
浏览文件 @ 0c252a6a
# 开发参考
- [基于JS扩展的类Web开发范式](arkui-js/Readme-CN.md)
- [基于TS扩展的声明式开发范式](arkui-ts/Readme-CN.md)
- [组件参考（基于JS扩展的类Web开发范式）](arkui-js/Readme-CN.md)
- [组件参考（基于TS扩展的声明式开发范式）](arkui-ts/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/Readme-CN.md
浏览文件 @ 0c252a6a
......@@ -121,7 +121,7 @@
- 资源调度
- [@ohos.backgroundTaskManager (后台任务管理)](js-apis-backgroundTaskManager.md)
- [@ohos.distributedMissionManager (distributedMissionManager)](js-apis-distributedMissionManager.md)
- [@ohos.distributedMissionManager (分布式任务管理)](js-apis-distributedMissionManager.md)
- [@ohos.workScheduler (延迟任务调度)](js-apis-workScheduler.md)
- [@ohos.WorkSchedulerExtensionAbility (延迟任务调度回调)](js-apis-WorkSchedulerExtensionAbility.md)
- 定制管理
......
zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md
浏览文件 @ 0c252a6a
......@@ -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-animator.md
浏览文件 @ 0c252a6a
......@@ -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-backgroundTaskManager.md
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -6,7 +6,7 @@
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块接口均为系统接口，三方应用不支持调用。
> 本模块接口均为系统接口。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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-i18n.md
浏览文件 @ 0c252a6a
......@@ -3,7 +3,7 @@
本模块提供系统相关的或者增强的国际化能力，包括区域管理、电话号码处理、日历等，相关接口为ECMA 402标准中未定义的补充接口。
[Intl模块](js-apis-intl.md)提供了ECMA 402标准定义的基础国际化接口，与本模块共同使用可提供完整地国际化支持能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> **说明：**
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> - I18N模块包含国际化能力增强接口（未在ECMA 402中定义），包括区域管理、电话号码处理、日历等，国际化基础能力请参考[Intl模块](js-apis-intl.md)。
......@@ -11,7 +11,7 @@
## 导入模块
```
```js
import i18n from '@ohos.i18n';
```
......@@ -37,7 +37,7 @@ getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): st
| string | 指定语言的本地化显示文本。 |
**示例：**
```
```js
i18n.getDisplayLanguage("zh", "en-GB", true);
i18n.getDisplayLanguage("zh", "en-GB");
```
......@@ -64,7 +64,7 @@ getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): stri
| string | 指定国家的本地化显示文本。 |
**示例：**
```
```js
i18n.getDisplayCountry("zh-CN", "en-GB", true);
i18n.getDisplayCountry("zh-CN", "en-GB");
```
......@@ -89,7 +89,7 @@ isRTL(locale: string): boolean
| boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 |
**示例：**
```
```js
i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false
i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true
```
......@@ -109,7 +109,7 @@ getSystemLanguage(): string
| string | 系统语言ID。 |
**示例：**
```
```js
i18n.getSystemLanguage();
```
......@@ -120,7 +120,7 @@ setSystemLanguage(language: string): boolean
设置系统语言。当前调用该接口不支持系统界面语言的实时刷新。
该接口为系统接口。
此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
......@@ -137,7 +137,7 @@ setSystemLanguage(language: string): boolean
| boolean | 返回true，表示系统语言设置成功；返回false，表示系统语言设置失败。 |
**示例：**
```
```js
i18n.setSystemLanguage('zh');
```
......@@ -148,9 +148,9 @@ getSystemLanguages(): Array&lt;string&gt;
获取系统支持的语言列表。
**系统能力**：SystemCapability.Global.I18n
此接口为系统接口。
**系统API**: 该接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Global.I18n
**返回值：**
| 类型 | 说明 |
......@@ -158,7 +158,7 @@ getSystemLanguages(): Array&lt;string&gt;
| Array&lt;string&gt; | 系统支持的语言ID列表。 |
**示例：**
```
```js
i18n.getSystemLanguages();
```
......@@ -169,9 +169,9 @@ getSystemCountries(language: string): Array&lt;string&gt;
获取针对输入语言系统支持的区域列表。
**系统能力**：SystemCapability.Global.I18n
此接口为系统接口。
**系统API**: 该接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 说明 |
......@@ -184,7 +184,7 @@ getSystemCountries(language: string): Array&lt;string&gt;
| Array&lt;string&gt; | 系统支持的区域ID列表。 |
**示例：**
```
```js
i18n.getSystemCountries('zh');
```
......@@ -203,7 +203,7 @@ getSystemRegion(): string
| string | 系统地区ID。 |
**示例：**
```
```js
i18n.getSystemRegion();
```
......@@ -214,7 +214,7 @@ setSystemRegion(region: string): boolean
设置系统区域。
该接口为系统接口。
此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
......@@ -231,7 +231,7 @@ setSystemRegion(region: string): boolean
| boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 |
**示例：**
```
```js
i18n.setSystemRegion('CN');
```
......@@ -250,7 +250,7 @@ getSystemLocale(): string
| string | 系统区域ID。 |
**示例：**
```
```js
i18n.getSystemLocale();
```
......@@ -261,7 +261,7 @@ setSystemLocale(locale: string): boolean
设置系统Locale。
该接口为系统接口。
此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
......@@ -278,7 +278,7 @@ setSystemLocale(locale: string): boolean
| boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 |
**示例：**
```
```js
i18n.setSystemLocale('zh-CN');
```
......@@ -289,9 +289,9 @@ isSuggested(language: string, region?: string): boolean
判断当前语言和区域是否匹配。
**系统能力**：SystemCapability.Global.I18n
此接口为系统接口。
**系统API**: 该接口为系统接口，三方应用不支持调用。
**系统能力**：SystemCapability.Global.I18n
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -305,7 +305,7 @@ isSuggested(language: string, region?: string): boolean
| boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 |
**示例：**
```
```js
i18n.isSuggested('zh', 'CN');
```
......@@ -330,7 +330,7 @@ getCalendar(locale: string, type? : string): Calendar
| [Calendar](#calendar8) | 日历对象。 |
**示例：**
```
```js
i18n.getCalendar("zh-Hans", "gregory");
```
......@@ -352,7 +352,7 @@ setTime(date: Date): void
| date | Date | 是 | 将要设置的日历对象的内部时间日期。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("en-US", "gregory");
var date = new Date(2021, 10, 7, 8, 0, 0, 0);
calendar.setTime(date);
......@@ -373,7 +373,7 @@ setTime(time: number): void
| time | number | 是 | time为从1970.1.1&nbsp;00:00:00&nbsp;GMT逝去的毫秒数。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("en-US", "gregory");
calendar.setTime(10540800000);
```
......@@ -398,7 +398,7 @@ set(year: number, month: number, date:number, hour?: number, minute?: number, se
| second | number | 否 | 设置的秒。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
```
......@@ -418,7 +418,7 @@ setTimeZone(timezone: string): void
| timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
```
......@@ -438,7 +438,7 @@ getTimeZone(): string
| string | 日历对象的时区id。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.setTimeZone("Asia/Shanghai");
calendar.getTimeZone(); // Asia/Shanghai"
......@@ -459,7 +459,7 @@ getFirstDayOfWeek(): number
| number | 获取一周的起始日，1代表周日，7代表周六。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("en-US", "gregory");
calendar.getFirstDayOfWeek();
```
......@@ -479,7 +479,7 @@ setFirstDayOfWeek(value: number): void
| value | number | 否 | 设置一周的起始日，1代表周日，7代表周六。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.setFirstDayOfWeek(0);
```
......@@ -499,7 +499,7 @@ getMinimalDaysInFirstWeek(): number
| number | 一年中第一周的最小天数。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.getMinimalDaysInFirstWeek();
```
......@@ -519,7 +519,7 @@ setMinimalDaysInFirstWeek(value: number): void
| value | number | 否 | 一年中第一周的最小天数。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.setMinimalDaysInFirstWeek(3);
```
......@@ -544,7 +544,7 @@ get(field: string): number
| number | 与field相关联的值，如当前Calendar对象的内部日期的年份为1990，get("year")返回1990。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00
calendar.get("hour_of_day"); // 8
......@@ -570,7 +570,7 @@ getDisplayName(locale: string): string
| string | 日历在locale所指示的区域的名字。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("en-US", "buddhist");
calendar.getDisplayName("zh"); // 佛历
```
......@@ -595,7 +595,7 @@ isWeekend(date?: Date): boolean
| boolean | 当所判断的日期为周末时，返回&nbsp;true，否则返回false。 |
**示例：**
```
```js
var calendar = i18n.getCalendar("zh-Hans");
calendar.set(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00
calendar.isWeekend(); // false
......@@ -622,7 +622,7 @@ constructor(country: string, options?: PhoneNumberFormatOptions)
| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 |
**示例：**
```
```js
var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"});
```
......@@ -646,7 +646,7 @@ isValidNumber(number: string): boolean
| boolean | 返回true表示电话号码的格式正确，返回false表示电话号码的格式错误。 |
**示例：**
```
```js
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.isValidNumber("15812312312");
```
......@@ -671,7 +671,7 @@ format(number: string): string
| string | 格式化后的电话号码。 |
**示例：**
```
```js
var phonenumberfmt = new i18n.PhoneNumberFormat("CN");
phonenumberfmt.format("15812312312");
```
......@@ -687,17 +687,17 @@ static getLocationName(number: string, locale: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------- |
| ------ | ------ | ---- | ---- |
| number | string | 是 | 电话号码 |
| locale | string | 是 | 区域ID |
**返回值：**
| 类型 | 说明 |
| ------ | ---------- |
| ------ | -------- |
| string | 电话号码归属地。 |
**示例：**
```
```js
var location = i18n.PhoneNumberFormat.getLocationName('15812312345', 'zh-CN');
```
......@@ -706,7 +706,7 @@ static getLocationName(number: string, locale: string): string
表示电话号码格式化对象可设置的属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ---- | ------ | ---- | ---- | ---------------------------------------- |
......@@ -717,7 +717,7 @@ static getLocationName(number: string, locale: string): string
度量衡单位信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.I18n
**系统能力**：SystemCapability.Global.I18n
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------------- | ------ | ---- | ---- | ---------------------------------------- |
......@@ -751,7 +751,7 @@ static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale:
| string | 按照toUnit的单位格式化后，得到的字符串。 |
**示例：**
```
```js
i18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long");
```
......@@ -766,16 +766,16 @@ static getDateOrder(locale: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------------------- |
| ------ | ------ | ---- | ------------------------- |
| locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 |
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| ------ | ------------------- |
| string | 返回某一区域的日期的年、月、日排列顺序 |
**示例：**
```
```js
i18n.Util.getDateOrder("zh-CN");
```
......@@ -799,7 +799,7 @@ getInstance(locale?:string): IndexUtil
| [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 |
**示例：**
```
```js
var indexUtil= i18n.getInstance("zh-CN");
```
......@@ -821,7 +821,7 @@ getIndexList(): Array&lt;string&gt;
| Array&lt;string&gt; | 返回当前locale对应的索引列表。 |
**示例：**
```
```js
var indexUtil = i18n.getInstance("zh-CN");
var indexList = indexUtil.getIndexList();
```
......@@ -841,7 +841,7 @@ addLocale(locale: string): void
| locale | string | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 |
**示例：**
```
```js
var indexUtil = i18n.getInstance("zh-CN");
indexUtil.addLocale("en-US");
```
......@@ -866,9 +866,9 @@ getIndex(text: string): string
| string | 输入文本对应的索引值。 |
**示例：**
```
```js
var indexUtil= i18n.getInstance("zh-CN");
indexUtil.getIndex("hi"); // 返回h
indexUtil.getIndex("hi"); // 返回hi
```
......@@ -894,7 +894,7 @@ static isDigit(char: string): boolean
| boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 |
**示例：**
```
```js
var isdigit = i18n.Character.isDigit("1"); // 返回true
```
......@@ -918,7 +918,7 @@ static isSpaceChar(char: string): boolean
| boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 |
**示例：**
```
```js
var isspacechar = i18n.Character.isSpaceChar("a"); // 返回false
```
......@@ -942,7 +942,7 @@ static isWhitespace(char: string): boolean
| boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 |
**示例：**
```
```js
var iswhitespace = i18n.Character.isWhitespace("a"); // 返回false
```
......@@ -966,7 +966,7 @@ static isRTL(char: string): boolean
| boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 |
**示例：**
```
```js
var isrtl = i18n.Character.isRTL("a"); // 返回false
```
......@@ -990,7 +990,7 @@ static isIdeograph(char: string): boolean
| boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 |
**示例：**
```
```js
var isideograph = i18n.Character.isIdeograph("a"); // 返回false
```
......@@ -1014,7 +1014,7 @@ static isLetter(char: string): boolean
| boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 |
**示例：**
```
```js
var isletter = i18n.Character.isLetter("a"); // 返回true
```
......@@ -1038,7 +1038,7 @@ static isLowerCase(char: string): boolean
| boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 |
**示例：**
```
```js
var islowercase = i18n.Character.isLowerCase("a"); // 返回true
```
......@@ -1062,7 +1062,7 @@ static isUpperCase(char: string): boolean
| boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 |
**示例：**
```
```js
var isuppercase = i18n.Character.isUpperCase("a"); // 返回false
```
......@@ -1086,7 +1086,7 @@ static getType(char: string): string
| string | 输入字符的一般类别值。 |
**示例：**
```
```js
var type = i18n.Character.getType("a");
```
......@@ -1110,7 +1110,7 @@ getLineInstance(locale: string): BreakIterator
| [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
```
......@@ -1132,7 +1132,7 @@ setLineBreakText(text: string): void
| text | string | 是 | 指定BreakIterator进行断句的文本。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
```
......@@ -1152,7 +1152,7 @@ getLineBreakText(): string
| string | BreakIterator对象正在处理的文本 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.getLineBreakText(); // Apple is my favorite fruit.
......@@ -1173,7 +1173,7 @@ current(): number
| number | BreakIterator在当前所处理的文本中的位置。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.current(); // 0
......@@ -1194,7 +1194,7 @@ first(): number
| number | 被处理文本的第一个分割点的偏移量。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
......@@ -1215,7 +1215,7 @@ last(): number
| number | 被处理的文本的最后一个分割点的偏移量 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.last(); // 27
......@@ -1241,7 +1241,7 @@ next(index?: number): number
| number | 返回移动了index个分割点后，当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
......@@ -1264,7 +1264,7 @@ previous(): number
| number | 返回移动到前一个分割点后，当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.first(); // 0
......@@ -1292,7 +1292,7 @@ following(offset: number): number
| number | 返回[BreakIterator](#breakiterator8)移动后的位置，如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.following(0); // 6
......@@ -1320,7 +1320,7 @@ isBoundary(offset: number): boolean
| boolean | 如果是一个分割点返回true,&nbsp;否则返回false。 |
**示例：**
```
```js
var iterator = i18n.getLineInstance("en");
iterator.setLineBreakText("Apple is my favorite fruit.");
iterator.isBoundary(0); // true;
......@@ -1342,7 +1342,7 @@ is24HourClock(): boolean
| boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 |
**示例：**
```
```js
var is24HourClock = i18n.is24HourClock();
```
......@@ -1368,7 +1368,7 @@ set24HourClock(option: boolean): boolean
| boolean | 返回true，表示修改成功；返回false，表示修改失败。 |
**示例：**
```
```js
// 将系统时间设置为24小时制
var success = i18n.set24HourClock(true);
```
......@@ -1396,7 +1396,7 @@ addPreferredLanguage(language: string, index?: number): boolean
| boolean | 返回true，表示添加成功；返回false，表示添加失败。 |
**示例：**
```
```js
// 将语言zh-CN添加到系统偏好语言列表中
var language = 'zh-CN';
var index = 0;
......@@ -1425,7 +1425,7 @@ removePreferredLanguage(index: number): boolean
| boolean | 返回true，表示删除成功；返回false，表示删除失败。 |
**示例：**
```
```js
// 删除系统偏好语言列表中的第一个偏好语言
var index = 0;
var success = i18n.removePreferredLanguage(index);
......@@ -1446,7 +1446,7 @@ getPreferredLanguageList(): Array&lt;string&gt;
| Array&lt;string&gt; | 系统偏好语言列表。 |
**示例：**
```
```js
var preferredLanguageList = i18n.getPreferredLanguageList();
```
......@@ -1465,7 +1465,7 @@ getFirstPreferredLanguage(): string
| string | 偏好语言列表中的第一个语言。 |
**示例：**
```
```js
var firstPreferredLanguage = i18n.getFirstPreferredLanguage();
```
......@@ -1480,11 +1480,11 @@ getAppPreferredLanguage(): string
**返回值：**
| 类型 | 说明 |
| ------ | -------------- |
| ------ | -------- |
| string | 应用的偏好语言。 |
**示例：**
```
```js
var appPreferredLanguage = i18n.getAppPreferredLanguage();
```
......@@ -1508,7 +1508,7 @@ getTimeZone(zoneID?: string): TimeZone
| TimeZone | 时区ID对应的时区对象。 |
**示例：**
```
```js
var timezone = i18n.getTimeZone();
```
......@@ -1530,7 +1530,7 @@ getID(): string
| string | 时区对象对应的时区ID。 |
**示例：**
```
```js
var timezone = i18n.getTimeZone();
timezone.getID();
```
......@@ -1556,7 +1556,7 @@ getDisplayName(locale?: string, isDST?: boolean): string
| string | 时区对象在指定区域的表示。 |
**示例：**
```
```js
var timezone = i18n.getTimeZone();
timezone.getDisplayName("zh-CN", false);
```
......@@ -1576,7 +1576,7 @@ getRawOffset(): number
| number | 时区对象表示的时区与UTC时区的偏差。 |
**示例：**
```
```js
var timezone = i18n.getTimeZone();
timezone.getRawOffset();
```
......@@ -1596,7 +1596,7 @@ getOffset(date?: number): number
| number | 某一时刻时区对象表示的时区与UTC时区的偏差。 |
**示例：**
```
```js
var timezone = i18n.getTimeZone();
timezone.getOffset(1234567890);
```
......@@ -1612,11 +1612,11 @@ static getAvailableIDs(): Array&lt;string&gt;
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| ------------------- | ----------- |
| Array&lt;string&gt; | 系统支持的时区ID列表 |
**示例：**
```
```ts
var ids = i18n.TimeZone.getAvailableIDs();
```
......@@ -1631,11 +1631,11 @@ static getAvailableZoneCityIDs(): Array&lt;string&gt;
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| ------------------- | ------------- |
| Array&lt;string&gt; | 系统支持的时区城市ID列表 |
**示例：**
```
```ts
var cityIDs = i18n.TimeZone.getAvailableZoneCityIDs();
```
......@@ -1650,17 +1650,17 @@ static getCityDisplayName(cityID: string, locale: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID |
| locale | string | 是 | 区域ID |
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| ------ | ------------------ |
| string | 时区城市在locale下的本地化显示 |
**示例：**
```
```ts
var displayName = i18n.TimeZone.getCityDisplayName("Shanghai", "zh-CN");
```
......@@ -1675,16 +1675,16 @@ static getTimezoneFromCity(cityID: string): TimeZone
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| ------ | ------ | ---- | ------ |
| cityID | string | 是 | 时区城市ID |
**返回值：**
| 类型 | 说明 |
| ------ | ----------------------- |
| -------- | ----------- |
| TimeZone | 时区城市对应的时区对象 |
**示例：**
```
```ts
var timezone = i18n.TimeZone.getTimezoneFromCity("Shanghai");
```
......@@ -1695,7 +1695,7 @@ setUsingLocalDigit(flag: boolean): boolean
设置是否打开本地数字开关。
该接口为系统接口。
此接口为系统接口。
**需要权限**：ohos.permission.UPDATE_CONFIGURATION
......@@ -1703,16 +1703,16 @@ setUsingLocalDigit(flag: boolean): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ----- |
| ---- | ------- | ---- | ------------------------------- |
| flag | boolean | 是 | true表示打开本地数字开关，false表示关闭本地数字开关。 |
**返回值：**
| 类型 | 说明 |
| -------- | ------------ |
| ------- | ----------------------------------- |
| boolean | true表示本地数字开关设置成功，false表示本地数字开关设置失败。 |
**示例：**
```
```ts
var status = i18n.setUsingLocalDigit(true);
```
......@@ -1727,11 +1727,11 @@ getUsingLocalDigit(): boolean
**返回值：**
| 类型 | 说明 |
| -------- | ------------ |
| ------- | ---------------------------------------- |
| boolean | true表示系统当前已打开本地数字开关，false表示系统当前未打开本地数字开关。 |
**示例：**
```
```ts
var status = i18n.getUsingLocalDigit();
```
......@@ -1749,11 +1749,11 @@ static getAvailableIDs(): string[]
**返回值：**
| 类型 | 说明 |
| ------ | ------------ |
| -------- | ---------- |
| string[] | 音译支持的ID列表。 |
**示例：**
```
```ts
i18n.Transliterator.getAvailableIDs();
```
......@@ -1768,16 +1768,16 @@ static getInstance(id: string): Transliterator
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- |
| ---- | ------ | ---- | -------- |
| id | string | 是 | 音译支持的ID。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------- |
| ---------------------------------- | ----- |
| [Transliterator](#transliterator9) | 音译对象。 |
**示例：**
```
```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
```
......@@ -1792,16 +1792,16 @@ transform(text: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | -------------------- |
| ---- | ------ | ---- | ------ |
| text | string | 是 | 输入字符串。 |
**返回值：**
| 类型 | 说明 |
| ------ | ------------- |
| ------ | -------- |
| string | 转换后的字符串。 |
**示例：**
```
```ts
var transliterator = i18n.Transliterator.getInstance("Any-Latn");
transliterator.transform("中国");
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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-resource-manager.md
浏览文件 @ 0c252a6a
......@@ -9,7 +9,7 @@
## 导入模块
```
```js
import resourceManager from '@ohos.resourceManager';
```
......@@ -17,7 +17,7 @@ import resourceManager from '@ohos.resourceManager';
从API Version9开始，Stage模型支持了通过context获取resourceManager对象的方式，再调用其内部获取资源的接口，无需再导入包，此方式FA模型不适用。
```
```ts
this.context.resourceManager;
```
......@@ -37,7 +37,7 @@ getResourceManager(callback: AsyncCallback&lt;ResourceManager&gt;): void
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
**示例：**
```
```js
resourceManager.getResourceManager((error, mgr) => {
if (error != null) {
console.log("error is " + error);
......@@ -71,7 +71,7 @@ getResourceManager(bundleName: string, callback: AsyncCallback&lt;ResourceManage
| callback | AsyncCallback&lt;[ResourceManager](#resourcemanager)&gt; | 是 | callback方式返回ResourceManager对象 |
**示例：**
```
```js
resourceManager.getResourceManager("com.example.myapplication", (error, mgr) => {
});
```
......@@ -93,7 +93,7 @@ getResourceManager(): Promise&lt;ResourceManager&gt;
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 |
**示例：**
```
```js
resourceManager.getResourceManager().then(mgr => {
mgr.getString(0x1000000, (error, value) => {
if (error != null) {
......@@ -129,11 +129,9 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 |
**示例：**
```
```js
resourceManager.getResourceManager("com.example.myapplication").then(mgr => {
}).catch(error => {
});
```
......@@ -142,7 +140,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示设备屏幕方向。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力**：SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- |
......@@ -154,7 +152,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示当前设备类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力**：SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------------- | ---- | ---- |
......@@ -170,7 +168,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
用于表示当前设备屏幕密度。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力**：SystemCapability.Global.ResourceManager
| 名称 | 默认值 | 说明 |
| -------------- | ---- | ---------- |
......@@ -186,7 +184,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
表示当前设备的状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力**：SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
......@@ -196,7 +194,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
**示例：**
```
```js
resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => {
let direction = value.direction;
......@@ -209,7 +207,7 @@ resourceManager.getResourceManager((error, mgr) => {
表示设备支持的能力。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
**系统能力**：SystemCapability.Global.ResourceManager
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
......@@ -219,7 +217,7 @@ resourceManager.getResourceManager((error, mgr) => {
**示例：**
```
```js
resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => {
let screenDensity = value.screenDensity;
......@@ -230,8 +228,9 @@ resourceManager.getResourceManager((error, mgr) => {
## RawFileDescriptor<sup>8+</sup>
表示rawfile的descriptor信息。<br>
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
表示rawfile的descriptor信息。
**系统能力：** SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ |
......@@ -246,7 +245,7 @@ resourceManager.getResourceManager((error, mgr) => {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ |
| ---------- | ------ | ----------- |
| bundleName | string | 应用的bundle名称 |
| moduleName | string | 应用的module名称 |
| id | number | 资源的id值 |
......@@ -278,7 +277,7 @@ getString(resId: number, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的字符串 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id, (error, value) => {
if (error != null) {
......@@ -310,7 +309,7 @@ getString(resId: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 资源ID值对应的字符串 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getString($r('app.string.test').id).then(value => {
let str = value;
......@@ -336,7 +335,7 @@ getString(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的字符串 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -361,16 +360,16 @@ getString(resource: Resource): Promise&lt;string&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| --------------------- | ---------------- |
| Promise&lt;string&gt; | resource对象对应的字符串 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -398,7 +397,7 @@ getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调，用于返回获取的字符串数组 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id, (error, value) => {
if (error != null) {
......@@ -430,7 +429,7 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getStringArray($r('app.strarray.test').id).then(value => {
let strArray = value;
......@@ -450,12 +449,12 @@ getStringArray(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| -------- | ---------------------------------------- | ---- | ----------------- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调，用于返回获取的字符串数组 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -480,16 +479,16 @@ getStringArray(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -517,7 +516,7 @@ getMedia(resId: number, callback: AsyncCallback&lt;Uint8Array&gt;): void
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调，用于返回获取的媒体文件内容 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id, (error, value) => {
if (error != null) {
......@@ -549,7 +548,7 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt;
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getMedia($r('app.media.test').id).then(value => {
let media = value;
......@@ -569,12 +568,12 @@ getMedia(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| -------- | ------------------------------- | ---- | ------------------ |
| resource | [Resource](#resource9) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调，用于返回获取的媒体文件内容 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -599,16 +598,16 @@ getMedia(resource: Resource): Promise&lt;Uint8Array&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------------------------- | ------------------- |
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -636,7 +635,7 @@ getMediaBase64(resId: number, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的图片资源Base64编码 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id, (error, value) => {
if (error != null) {
......@@ -668,7 +667,7 @@ getMediaBase64(resId: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getMediaBase64($r('app.media.test').id).then(value => {
let media = value;
......@@ -693,7 +692,7 @@ getMediaBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的图片资源Base64编码 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -718,16 +717,16 @@ getMediaBase64(resource: Resource): Promise&lt;string&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | -------------------- |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -755,7 +754,7 @@ getConfiguration(callback: AsyncCallback&lt;Configuration&gt;): void
| callback | AsyncCallback&lt;[Configuration](#configuration)&gt; | 是 | 异步回调，用于返回设备的Configuration |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration((error, value) => {
if (error != null) {
......@@ -783,7 +782,7 @@ getConfiguration(): Promise&lt;Configuration&gt;
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getConfiguration().then(value => {
let direction = value.direction;
......@@ -809,7 +808,7 @@ getDeviceCapability(callback: AsyncCallback&lt;DeviceCapability&gt;): void
| callback | AsyncCallback&lt;[DeviceCapability](#devicecapability)&gt; | 是 | 异步回调，用于返回设备的DeviceCapability |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability((error, value) => {
if (error != null) {
......@@ -837,7 +836,7 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt;
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getDeviceCapability().then(value => {
let screenDensity = value.screenDensity;
......@@ -865,7 +864,7 @@ getPluralString(resId: number, num: number, callback: AsyncCallback&lt;string&gt
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，返回根据指定数量获取指定ID字符串表示的单复数字符串 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1, (error, value) => {
if (error != null) {
......@@ -898,7 +897,7 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt;
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getPluralString($r("app.plural.test").id, 1).then(value => {
let str = value;
......@@ -918,13 +917,13 @@ getPluralString(resource: Resource, num: number, callback: AsyncCallback&lt;stri
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- |
| -------- | --------------------------- | ---- | ------------------------------------ |
| resource | [Resource](#resource9) | 是 | 资源信息 |
| num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，返回根据指定数量获取指定resource对象表示的单复数字符串 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -949,17 +948,17 @@ getPluralString(resource: Resource, num: number): Promise&lt;string&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
| num | number | 是 | 数量值 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| --------------------- | ------------------------------ |
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -987,7 +986,7 @@ getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调，用于返回获取的rawfile文件内容 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml", (error, value) => {
if (error != null) {
......@@ -1018,7 +1017,7 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt;
| Promise&lt;Uint8Array&gt; | rawfile文件内容 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFile("test.xml").then(value => {
let rawFile = value;
......@@ -1043,7 +1042,7 @@ getRawFileDescriptor(path: string, callback: AsyncCallback&lt;RawFileDescriptor&
| callback | AsyncCallback&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | 是 | 异步回调，用于返回获取的rawfile文件的descriptor |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml", (error, value) => {
if (error != null) {
......@@ -1076,7 +1075,7 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt;
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.getRawFileDescriptor("test.xml").then(value => {
let fd = value.fd;
......@@ -1103,7 +1102,7 @@ closeRawFileDescriptor(path: string, callback: AsyncCallback&lt;void&gt;): void
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml", (error, value) => {
if (error != null) {
......@@ -1132,7 +1131,7 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt;
| Promise&lt;void&gt; | 无返回值 |
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.closeRawFileDescriptor("test.xml").then(value => {
let result = value;
......@@ -1151,7 +1150,7 @@ release()
**系统能力**：SystemCapability.Global.ResourceManager
**示例：**
```
```ts
resourceManager.getResourceManager((error, mgr) => {
mgr.release();
});
......@@ -1172,7 +1171,7 @@ getStringByName(resName: string, callback: AsyncCallback&lt;string&gt;): void
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的字符串 |
**示例：**
```
```ts
this.context.resourceManager.getStringByName("test", (error, value) => {
if (error != null) {
console.log("error is " + error);
......@@ -1197,11 +1196,11 @@ getStringByName(resName: string): Promise&lt;string&gt;
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| --------------------- | ---------- |
| Promise&lt;string&gt; | 资源名称对应的字符串 |
**示例：**
```
```ts
this.context.resourceManager.getStringByName("test").then(value => {
let string = value;
}).catch(error => {
......@@ -1224,7 +1223,7 @@ getStringArrayByName(resName: string, callback: AsyncCallback&lt;Array&lt;string
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调，用于返回获取的字符串数组 |
**示例：**
```
```ts
this.context.resourceManager.getStringArrayByName("test", (error, value) => {
if (error != null) {
console.log("error is " + error);
......@@ -1244,16 +1243,16 @@ getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------- | ------------- |
| ---------------------------------- | ------------ |
| Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 |
**示例：**
```
```ts
this.context.resourceManager.getStringArrayByName("test").then(value => {
let strArray = value;
}).catch(error => {
......@@ -1276,7 +1275,7 @@ getMediaByName(resName: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调，用于返回获取的媒体文件内容 |
**示例：**
```
```ts
this.context.resourceManager.getMediaByName("test", (error, value) => {
if (error != null) {
console.log("error is " + error);
......@@ -1296,16 +1295,16 @@ getMediaByName(resName: string): Promise&lt;Uint8Array&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| ------------------------- | -------------- |
| ------------------------- | ------------- |
| Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 |
**示例：**
```
```ts
this.context.resourceManager.getMediaByName("test").then(value => {
let media = value;
}).catch(error => {
......@@ -1328,7 +1327,7 @@ getMediaBase64ByName(resName: string, callback: AsyncCallback&lt;string&gt;): vo
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的图片资源Base64编码 |
**示例：**
```
```ts
this.context.resourceManager.getMediaBase64ByName("test", (error, value) => {
if (error != null) {
console.log("error is " + error);
......@@ -1348,16 +1347,16 @@ getMediaBase64ByName(resName: string): Promise&lt;string&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| --------------------- | -------------------- |
| --------------------- | ------------------- |
| Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 |
**示例：**
```
```ts
this.context.resourceManager.getMediaBase64ByName("test").then(value => {
let media = value;
}).catch(error => {
......@@ -1375,13 +1374,13 @@ getPluralStringByName(resName: string, num: number, callback: AsyncCallback&lt;s
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- |
| -------- | --------------------------- | ---- | ----------------------------- |
| resName | string | 是 | 资源名称 |
| num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，返回根据传入的数量值获取资源名称对应的字符串资源 |
**示例：**
```
```ts
this.context.resourceManager.getPluralStringByName("test", 1, (error, value) => {
if (error != null) {
console.log("error is " + error);
......@@ -1401,17 +1400,17 @@ getPluralStringByName(resName: string, num: number): Promise&lt;string&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
| num | number | 是 | 数量值 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| --------------------- | ---------------------- |
| Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 |
**示例：**
```
```ts
this.context.resourceManager.getPluralStringByName("test", 1).then(value => {
let str = value;
}).catch(error => {
......@@ -1434,11 +1433,11 @@ getStringSync(resId: number): string
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | ----------- |
| string | 资源ID值对应的字符串 |
**示例：**
```
```ts
this.context.resourceManager.getStringSync($r('app.string.test').id);
```
......@@ -1452,16 +1451,16 @@ getStringSync(resource: Resource): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | ---------------- |
| string | resource对象对应的字符串 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -1480,16 +1479,16 @@ getStringByNameSync(resName: string): string
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | ---------- |
| string | 资源名称对应的字符串 |
**示例：**
```
```ts
this.context.resourceManager.getStringByNameSync("test");
```
......@@ -1508,11 +1507,11 @@ getBoolean(resId: number): boolean
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------- | ------------ |
| boolean | 资源ID值对应的布尔结果 |
**示例：**
```
```ts
this.context.resourceManager.getBoolean($r('app.boolean.boolean_test').id);
```
### getBoolean<sup>9+</sup>
......@@ -1525,16 +1524,16 @@ getBoolean(resource: Resource): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------- | ----------------- |
| boolean | resource对象对应的布尔结果 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -1553,16 +1552,16 @@ getBooleanByName(resName: string): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------- | ----------- |
| boolean | 资源名称对应的布尔结果 |
**示例：**
```
```ts
this.context.resourceManager.getBooleanByName("boolean_test");
```
......@@ -1581,11 +1580,11 @@ getNumber(resId: number): number
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | ---------- |
| number | 资源ID值对应的数值 |
**示例：**
```
```ts
this.context.resourceManager.getNumber($r('app.integer.integer_test').id);
this.context.resourceManager.getNumber($r('app.float.float_test').id);
```
......@@ -1600,16 +1599,16 @@ getNumber(resource: Resource): number
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | --------------- |
| number | resource对象对应的数值 |
**示例：**
```
```ts
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
......@@ -1628,16 +1627,16 @@ getNumberByName(resName: string): number
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| ------ | --------- |
| number | 资源名称对应的数值 |
**示例：**
```
```ts
this.context.resourceManager.getNumberByName("integer_test");
this.context.resourceManager.getNumberByName("float_test");
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-touchevent.md
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
浏览文件 @ 0c252a6a
......@@ -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
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或