!18317 mmi_docs_api_update

Merge pull request !18317 from xixian/master

zh-cn/application-dev/reference/apis/Readme-CN.md

@@ -18,8 +18,6 @@
     - [@ohos.app.form.FormExtensionAbility (FormExtensionAbility)](js-apis-app-form-formExtensionAbility.md)
     - [@ohos.application.DataShareExtensionAbility (数据共享扩展能力)](js-apis-application-dataShareExtensionAbility.md)
     - [@ohos.application.StaticSubscriberExtensionAbility (StaticSubscriberExtensionAbility)](js-apis-application-staticSubscriberExtensionAbility.md)
-  - Stage模型能力的接口(待停用)
-    - [@ohos.application.EnvironmentCallback (EnvironmentCallback)](js-apis-application-environmentCallback.md)
   - FA模型能力的接口
     - [@ohos.ability.ability (Ability)](js-apis-ability-ability.md)
     - [@ohos.ability.featureAbility (FeatureAbility模块)](js-apis-ability-featureAbility.md)
@@ -336,6 +334,7 @@
   - [@ohos.multimodalInput.mouseEvent (鼠标输入事件)](js-apis-mouseevent.md)
   - [@ohos.multimodalInput.pointer (鼠标指针)](js-apis-pointer.md)
   - [@ohos.multimodalInput.touchEvent (触摸输入事件)](js-apis-touchevent.md)
+  - [@ohos.multimodalInput.shortKey (快捷键)](js-apis-shortKey.md)
   - [@ohos.power (系统电源管理)](js-apis-power.md)
   - [@ohos.runningLock (Runninglock锁)](js-apis-runninglock.md)
   - [@ohos.sensor (传感器)](js-apis-sensor.md)

zh-cn/application-dev/reference/apis/js-apis-pointer.md

@@ -258,6 +258,386 @@ try {
 }
 ```
 
+## pointer.setHoverScrollState<sup>10+</sup>
+
+setHoverScrollState(state: boolean, callback: AsyncCallback&lt;void&gt;): void
+
+设置鼠标悬停滚动开关状态，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名       | 类型                        | 必填   | 说明                                    |
+| -------- | ------------------------- | ---- | ------------------------------------- |
+| state    | boolean                    | 是    | 鼠标悬停滚动开关状态。   |
+| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setHoverScrollState(true, (error) => {
+    if (error) {
+      console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+      return;
+    }
+    console.log(`Set the mouse hover scroll success`);
+  });
+} catch (error) {
+  console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.setHoverScrollState<sup>10+</sup>
+
+setHoverScrollState(state: boolean): Promise&lt;void&gt;
+
+设置鼠标悬停滚动开关状态，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名    | 类型     | 必填   | 说明                                  |
+| ----- | ------ | ---- | ----------------------------------- |
+| state | boolean | 是    | 鼠标悬停滚动开关状态。 |
+
+**返回值**：
+
+| 参数                  | 说明               |
+| ------------------- | ---------------- |
+| Promise&lt;void&gt; | Promise对象。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setHoverScrollState(true).then(() => {
+    console.log(`Set the mouse hover scroll success`);
+  });
+} catch (error) {
+  console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getHoverScrollState<sup>10+</sup>
+
+getHoverScrollState(callback: AsyncCallback&lt;boolean&gt;): void
+
+获取鼠标悬停滚动开关状态，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名       | 类型                          | 必填   | 说明             |
+| -------- | --------------------------- | ---- | -------------- |
+| callback | AsyncCallback&lt;boolean&gt; | 是    | 回调函数，异步返回鼠标悬停滚动开关状态。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getHoverScrollState((error, state) => {
+    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
+  });
+} catch (error) {
+  console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getHoverScrollState<sup>10+</sup>
+
+getHoverScrollState(): Promise&lt;boolean&gt;
+
+获取当前鼠标悬停滚动开关状态，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**返回值**：
+
+| 参数                    | 说明                  |
+| --------------------- | ------------------- |
+| Promise&lt;boolean&gt; | Promise实例，异步返回鼠标悬停滚动开关状态。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getHoverScrollState().then((state) => {
+    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
+  });
+} catch (error) {
+  console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.setMousePrimaryButton<sup>10+</sup>
+
+setMousePrimaryButton(primary: PrimaryButton, callback: AsyncCallback&lt;void&gt;): void
+
+设置鼠标主键，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名    | 类型                      | 必填  | 说明                                    |
+| -------- | ------------------------- | ----  | ------------------------------------- |
+| primary  | [PrimaryButton](#primarybutton10)   | 是    | 鼠标主键id。   |
+| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error) => {
+    if (error) {
+      console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+      return;
+    }
+    console.log(`Set mouse primary button success`);
+  });
+} catch (error) {
+  console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.setMousePrimaryButton<sup>10+</sup>
+
+setMousePrimaryButton(primary: PrimaryButton): Promise&lt;void&gt;
+
+设置鼠标主键，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名    | 类型     | 必填   | 说明                                  |
+| ----- | ------ | ---- | ----------------------------------- |
+| primary | [PrimaryButton](#primarybutton10) | 是    | 鼠标主键id。 |
+
+**返回值**：
+
+| 参数                  | 说明               |
+| ------------------- | ---------------- |
+| Promise&lt;void&gt; | Promise对象。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT).then(() => {
+    console.log(`Set mouse primary button success`);
+  });
+} catch (error) {
+  console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getMousePrimaryButton<sup>10+</sup>
+
+getMousePrimaryButton(callback: AsyncCallback&lt;PrimaryButton&gt;): void
+
+获取鼠标主键，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名       | 类型                          | 必填   | 说明             |
+| -------- | --------------------------- | ---- | -------------- |
+| callback | AsyncCallback&lt;[PrimaryButton](#primarybutton10)&gt; | 是    | 回调函数，异步返回鼠标主键。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getMousePrimaryButton((error, primary) => {
+    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
+  });
+} catch (error) {
+  console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getMousePrimaryButton<sup>10+</sup>
+
+getMousePrimaryButton(): Promise&lt;PrimaryButton&gt;
+
+获取当前鼠标主键，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**返回值**：
+
+| 参数                    | 说明                  |
+| --------------------- | ------------------- |
+| Promise&lt;[PrimaryButton](#primarybutton10)&gt; | Promise实例，异步返回鼠标主键。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getMousePrimaryButton().then((primary) => {
+    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
+  });
+} catch (error) {
+  console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## PrimaryButton<sup>10+</sup>
+
+鼠标主键类型。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+| 名称                               | 值    | 说明     |
+| -------------------------------- | ---- | ------ |
+| LEFT                          | 0    | 鼠标左键     |
+| RIGHT                             | 1    | 鼠标右键   |
+
+## pointer.setMouseScrollRows<sup>10+</sup>
+
+setMouseScrollRows(rows: number, callback: AsyncCallback&lt;void&gt;): void
+
+设置鼠标滚动行数，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名       | 类型                        | 必填   | 说明                                    |
+| -------- | ------------------------- | ---- | ------------------------------------- |
+| rows     | number                    | 是    | 鼠标滚动行数，范围1-100，默认为3。   |
+| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setMouseScrollRows(1, (error) => {
+    if (error) {
+      console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+      return;
+    }
+    console.log(`setMouseScrollRows success`);
+  });
+} catch (error) {
+  console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.setMouseScrollRows<sup>10+</sup>
+
+setMouseScrollRows(rows: number): Promise&lt;void&gt;
+
+设置鼠标滚动行数，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名    | 类型     | 必填   | 说明                                  |
+| ----- | ------ | ---- | ----------------------------------- |
+| rows  | number | 是    | 鼠标滚动行数，范围1-100，默认为3。 |
+
+**返回值**：
+
+| 参数                  | 说明               |
+| ------------------- | ---------------- |
+| Promise&lt;void&gt; | Promise对象。 |
+
+**示例**：
+
+```js
+try {
+  pointer.setMouseScrollRows(20).then(() => {
+    console.log(`setMouseScrollRows success`);
+  });
+} catch (error) {
+  console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getMouseScrollRows<sup>10+</sup>
+
+getMouseScrollRows(callback: AsyncCallback&lt;number&gt;): void
+
+获取鼠标滚动行数，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**参数**：
+
+| 参数名       | 类型                          | 必填   | 说明             |
+| -------- | --------------------------- | ---- | -------------- |
+| callback | AsyncCallback&lt;number&gt; | 是    | 回调函数，异步返回鼠标滚动行数。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getMouseScrollRows((error, rows) => {
+    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
+  });
+} catch (error) {
+  console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+## pointer.getMouseScrollRows<sup>10+</sup>
+
+getMouseScrollRows(): Promise&lt;number&gt;
+
+获取当前鼠标滚动行数，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.Pointer
+
+**系统API**: 此接口为系统接口。
+
+**返回值**：
+
+| 参数                    | 说明                  |
+| --------------------- | ------------------- |
+| Promise&lt;number&gt; | Promise实例，异步返回鼠标滚动行数。 |
+
+**示例**：
+
+```js
+try {
+  pointer.getMouseScrollRows().then((rows) => {
+    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
+  });
+} catch (error) {
+  console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
 ## pointer.getPointerStyle<sup>9+</sup>
 
 getPointerStyle(windowId: number, callback: AsyncCallback&lt;PointerStyle&gt;): void

zh-cn/application-dev/reference/apis/js-apis-shortKey.md

+#  @ohos.multimodalInput.shortKey(快捷键)
+
+通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后进行截屏等。
+
+> **说明：**
+>
+> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+> - 本模块接口为系统接口。
+
+##  导入模块
+
+```
+import shortKey from '@ohos.multimodalInput.shortKey';
+```
+
+##  shortKey.setKeyDownDuration
+
+setKeyDownDuration(businessId: string, delay: number, callback: AsyncCallback<void>): void
+
+设置快捷键拉起Ability的延迟时间，使用AsyncCallback异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
+
+**参数**：
+
+| 参数名     | 类型                | 必填 | 说明                                                         |
+| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
+| businessId | string              | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
+| delay      | number              | 是   | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
+| callback   | AsyncCallback<void> | 是   | 回调函数。                                                   |
+
+**示例**：
+
+```
+try {
+  shortKey.setKeyDownDuration("screenshot", 500, (error) => {
+    if (error) {
+      console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+      return;
+    }
+    console.log(`Set key down duration success`);
+  });
+} catch (error) {
+  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```
+
+
+
+## shortKey.setKeyDownDuration
+
+setKeyDownDuration(businessId: string, delay: number): Promise<void>
+
+设置快捷键拉起Ability的延迟时间，使用Promise异步方式返回结果。
+
+**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
+
+**参数**：
+
+| 参数名     | 类型   | 必填 | 说明                                                         |
+| ---------- | ------ | ---- | ------------------------------------------------------------ |
+| businessId | string | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
+| delay      | number | 是   | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
+
+**返回值**：
+
+| 参数          | 说明          |
+| ------------- | ------------- |
+| Promise<void> | Promise对象。 |
+
+**示例**：
+
+```
+try {
+  shortKey.setKeyDownDuration("screenshot", 500).then(() => {
+    console.log(`Set key down duration success`);
+  });
+} catch (error) {
+  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
+}
+```