!2381 system接口填坑整改

Merge pull request !2381 from LiAn/master

!2381 system接口填坑整改
Merge pull request !2381 from LiAn/master
4fc7a62e · openharmony_ci · Gitee · a5efc96d · 1f4cb7ba · 4fc7a62e
4 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-basic-features-animator.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-basic-features-animator.md
@@ -6,191 +6,31 @@

 ## 导入模块

-requestAnimationFrame：无需导入
-
-cancelAnimationFrame：无需导入
-
-createAnimator：
-
 ```
 import animator from '@ohos.animator';
 ```

-## 权限列表
-
-无

+## createAnimator

-## requestAnimationFrame
+createAnimator(options: AnimatorOptions): AnimatorResult

-requestAnimationFrame(handler[, [ ...args]]): number
+定义Animator类。

-请求动画帧，逐帧回调JS函数。
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full

- 参数
+**参数：** 
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
-  | handler | Function | 是 | 表示要逐帧回调的函数。requestAnimationFrame函数回调handler函数时会在第一个参数位置传入timestamp时间戳。它表示requestAnimationFrame开始去执行回调函数的时刻。 |
-  | ...args | Array&lt;any&gt; | 否 | 附加参数，函数回调时，他们会作为参数传递给handler。 |
+  | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项，详细请参考AnimatorOptions。|

- 返回值
+**返回值：** 
  | 类型 | 说明 |
  | -------- | -------- |
-  | number | requestID请求的ID。 |
-
- 示例
-  ```
-  <!-- xxx.hml -->
-  <div class="container">
-    <button type="capsule" class="btn" onclick="beginAnimation">beginAnimation</button>
-  </div>
-  ```
-
-  ```
-  /* xxx.css */
-  .container {
-    flex-direction: column;
-    justify-content: center;
-    align-items: center;
-    width: 100%;
-    height: 100%;
-  }
-  .btn{
-    width: 300px;
-    margin-top: 40px;
-  }
-  ```
-
-  ```
-  /* xxx.js */
-  export default {
-    data: {
-      requestId: 0,
-      startTime: 0,
-    },
-    beginAnimation() {
-      cancelAnimationFrame(this.requestId);
-      this.requestId = requestAnimationFrame(this.runAnimation);
-    },
-    runAnimation(timestamp) {
-      if (this.startTime == 0) {
-        this.startTime = timestamp;
-      }
-      var elapsed = timestamp - this.startTime;
-      if (elapsed < 500) {
-        console.log('callback handler timestamp: ' + timestamp);
-        this.requestId = requestAnimationFrame(this.runAnimation);
-      }
-    }
-  }
-  ```
-
-
-## cancelAnimationFrame
-
-cancelAnimationFrame(requestId: number): void
-
-取消动画帧，取消逐帧回调请求。
-
- 参数
-  | 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
-  | requestId | number | 是 | 逐帧回调函数的标识id。 |
-
- 示例
-  ```
-  <!-- xxx.hml -->
-  <div class="container">
-    <button type="capsule" class="btn" onclick="beginAnimation">beginAnimation</button>
-    <button type="capsule" class="btn" onclick="stopAnimation">stopAnimation</button>
-  </div>
-  ```
+  | [AnimatorResult](#animatorresult) | Animator结果接口。 |

-  ```
-  /* xxx.css */
-  .container {
-    flex-direction: column;
-    justify-content: center;
-    align-items: center;
-    width: 100%;
-    height: 100%;
-  }
-  .btn{
-    width: 300px;
-    margin-top: 40px;
-  }
-  ```
+**示例：** 

-  ```
-  /* xxx.js */
-  export default {
-    data: {
-      requestId: 0,
-      startTime: 0,
-    },
-    beginAnimation() {
-      cancelAnimationFrame(this.requestId);
-      this.requestId = requestAnimationFrame(this.runAnimation);
-    },
-    runAnimation(timestamp) {
-      if (this.startTime == 0) {
-        this.startTime = timestamp;
-      }
-      var elapsed = timestamp - this.startTime;
-      if (elapsed < 500) {
-        console.log('callback handler timestamp: ' + timestamp);
-        this.requestId = requestAnimationFrame(this.runAnimation);
-      }
-    },
-    stopAnimation() {
-      cancelAnimationFrame(this.requestId);
-    }
-  }
-  ```
-
-
-## createAnimator
-
-createAnimator(options[...]): void
-
-创建动画对象。
-
- 参数
-  | 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
-  | options | Object | 是 | 表示待创建Animator对象的属性，详情见下表options说明。 |
-
- options说明
-  | 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
-  | duration | number | 否 | 动画播放的时长，单位毫秒，默认为0。 |
-  | easing | string | 否 | 动画插值曲线，默认为'&nbsp;ease&nbsp;'。 |
-  | delay | number | 否 | 动画延时播放时长，单位毫秒，默认为0，即不延时。 |
-  | fill | string | 否 | 动画启停模式，默认值none，详情见：[animation-fill-mode](../arkui-js/js-components-common-animation.md) |
-  | direction | string | 否 | 动画播放模式，默认值normal，详情见：[animation-direction](../arkui-js/js-components-common-animation.md) |
-  | iterations | number | 否 | 动画播放次数，默认值1，设置为0时不播放，设置为-1时无限次播放。 |
-  | begin | number | 否 | 动画插值起点，不设置时默认为0。 |
-  | end | number | 否 | 动画插值终点，不设置时默认为1。 |
-
- animator支持的接口
-  | 参数名 | 类型 | 说明 |
-  | -------- | -------- | -------- |
-  | update | options | 过程中可以使用这个接口更新动画参数，入参与createAnimator一致。 |
-  | play | - | 开始动画。 |
-  | finish | - | 结束动画。 |
-  | pause | - | 暂停动画。 |
-  | cancel | - | 取消动画。 |
-  | reverse | - | 倒播动画。 |
-
- animator支持的事件：
-  | 参数名 | 类型 | 说明 |
-  | -------- | -------- | -------- |
-  | frame | number | 逐帧插值回调事件，入参为当前帧的插值 |
-  | cancel | - | 动画被强制取消 |
-  | finish | - | 动画播放完成 |
-  | repeat | - | 动画重新播放 |
-
- 示例
  ```
  <!-- hml -->
  <div class="container">
@@ -237,3 +77,164 @@ createAnimator(options[...]): void
    }
  }
  ```
+
+## AnimatorResult
+
+定义Animator结果接口。
+
+### update
+
+update(options: AnimatorOptions): void
+
+更新当前动画器。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**参数：** 
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | options | [AnimatorOptions](#animatoroptions) | 是 | 定义动画选项。|
+
+**示例：**
+```
+animator.update(options)；
+```
+
+### play
+
+play(): void
+
+启动动画。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.play()；
+```
+
+### finish
+
+finish(): void
+
+结束动画。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.finish()；
+```
+
+### pause
+
+pause(): void
+
+暂停动画。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.pause()；
+```
+
+### cancel
+
+cancel(): void
+
+删除动画。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.cancel()；
+```
+
+### reverse
+
+reverse(): void
+
+以相反的顺序播放动画。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.reverse()；
+```
+
+### onframe
+
+onframe: (progress: number) => void
+
+回调时触发。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**参数：** 
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | progress | number | 是 | 动画的当前进度。|
+
+**示例：**
+```
+animator.onframe()；
+```
+
+### onfinish
+
+onfinish: () => void
+
+动画完成。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.onfinish()；
+```
+
+### oncancel
+
+oncancel: () => void
+
+动画被取消。
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.oncancel()；
+```
+
+### onrepeat
+
+onrepeat: () => void
+
+**系统能力：**  SystemCapability.ArkUI.ArkUI.Full
+
+**示例：**
+```
+animator.onrepeat()；
+```
+
+动画将重复。
+
+## AnimatorOptions
+
+定义动画选项。
+
+**系统能力：**  以下各项对应的系统能力均为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"。|
+| iterations | number | 是 | 动画播放次数，默认值1。设置为0时不播放，设置为-1时无限次播放。 |
+| begin | number | 是 | 动画插值起点，不设置时默认为0。 |
+| end | number | 是 | 动画插值终点，不设置时默认为1。 |
--- a/zh-cn/application-dev/reference/apis/js-apis-system-app.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-app.md
@@ -16,21 +16,17 @@ import app from '@system.app';

 ## app.getInfo

-getInfo(): &lt;AppResponse&gt;
+getInfo(): AppResponse

 获取当前应用配置文件中声明的信息。

 **系统能力：** SystemCapability.ArkUI.ArkUI.Lite

 **返回值：**
-**表1** AppResponse

-| 参数名 | 类型 | 说明 |
-| -------- | -------- | -------- |
-| appID<sup>6+</sup> | string | 表示应用的包名，用于标识应用的唯一性。 |
-| appName | string | 表示应用的名称。 |
-| versionName | string | 表示应用的版本名称。 |
-| versionCode | number | 表示应用的版本号。 |
+| 参数类型 | 说明 |
+| -------- | -------- |
+| [AppResponse](#appresponse) | 定义AppResponse信息。 |

 **示例：**

@@ -43,41 +39,6 @@ getInfo(): &lt;AppResponse&gt;
  }
  ```

-## app.screenOnVisible
-
-screenOnVisible(Object): void
-
-应用申请息屏不返回主表盘，再次亮屏依旧显示应用界面。
-
-**系统能力：** SystemCapability.ArkUI.ArkUI.Full
-
-**参数：**
-| 参数名 | 类型 | 必填 | 说明 |
-| -------- | -------- | -------- | -------- |
-| visible | boolean | 否 | 是否启动保活，默认值false。 |
-| success | Function | 否 | 接口调用成功的回调函数。 |
-| fail | Function | 否 | 接口调用失败的回调函数。 |
-| complete | Function | 否 | 接口调用结束的回调函数。 |
-
-**示例：**
-
-  ```
-  export default {    
-    screenOnVisible(){        
-      app.screenOnVisible({            
-        visible: true,            
-          success() {                
-            console.log('call app.keepVisible success');            
-          },            
-          fail(data, code) {                
-            console.log('call app.keepVisible fail');            
-          },
-      });    
-    }
-  }
-  ```
-
-
 ## app.terminate

 terminate(): void
@@ -94,10 +55,9 @@ terminate(): void
      app.terminate();    
    }}
  ```
-
 ## app.requestFullWindow

-requestFullWindow(duration: number): void
+requestFullWindow(options?: RequestFullWindowOptions): void

 请求应用以全窗口运行，FA在某些场景下（如半模态FA）会以非全窗口运行，调用该接口会从非全窗口切换为全窗口运行，如果已经以全窗口运行则该接口调用无效。

@@ -108,7 +68,7 @@ requestFullWindow(duration: number): void
 **参数：**
 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| duration | number | 否 | 请求全屏时，设定非全屏到全屏的过渡时间，单位为毫秒，默认时间与非全屏到全屏的距离成正比。 |
+| options | [RequestFullWindowOptions](#requestfullwindowoptions) | 否 | 请求全屏时，设定非全屏到全屏的过渡时间，单位为毫秒，默认时间与非全屏到全屏的距离成正比。 |

 **示例：**

@@ -119,4 +79,81 @@ requestFullWindow(duration: number): void
        duration: 200});    
    }
  }
-  ```
+ ```
+
+## app.setImageCacheCount
+
+setImageCacheCount(value: number): void
+
+设置解码图像计数的图像缓存容量。如果未设置，应用程序将不会缓存任何解码图像。
+
+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+**参数：**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| value | number | 否 | 解码图像计数的值容量。 |
+
+## app.setImageRawDataCacheSize
+
+setImageRawDataCacheSize(value: number): void
+
+在解码前设置原始图像数据大小的图像缓存容量（以字节为单位）。如果未设置，应用程序将不会缓存任何原始图像数据。
+
+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+**参数：**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| value | number | 否 | 原始图像数据大小的值容量（以字节为单位）。 |
+
+
+## app.setImageFileCacheSize
+
+setImageFileCacheSize(value: number): void
+
+在解码前设置磁盘上的图像文件缓存大小（以字节为单位）。如果未设置，应用程序将在磁盘上缓存100MB图像文件。
+
+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+**参数：**
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| value | number | 否 | 原始图像数据大小的值容量（以字节为单位）。 |
+
+## AppResponse
+
+定义AppResponse信息。
+
+**系统能力：**  以下各项对应的系统能力有所不同，详见下表。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- |-------- |
+| appID<sup>6+</sup> | string | 是 | 表示应用的包名，用于标识应用的唯一性。 <br> **系统能力：** SystemCapability.ArkUI.ArkUI.Full|
+| appName | string | 是 | 表示应用的名称。 <br> **系统能力：** SystemCapability.ArkUI.ArkUI.Lite|
+| versionName | string | 是 | 表示应用的版本名称。 <br> **系统能力：** SystemCapability.ArkUI.ArkUI.Lite|
+| versionCode | number | 是 | 表示应用的版本号。 <br> **系统能力：** SystemCapability.ArkUI.ArkUI.Lite|
+
+## ScreenOnVisibleOptions
+
+定义屏幕上可见接口的选项。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| visible | boolean | 否 | 是否启动保活，默认值false。 |
+| success | () => void | 否 | 接口调用成功的回调函数。 |
+| fail | (data: string, code: number) => void | 否 | 接口调用失败的回调函数。 |
+| complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+## RequestFullWindowOptions
+
+定义RequestFullWindow接口的选项。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| duration | number | 是 | 定义动画选项的数量。 |
+
--- a/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-mediaquery.md
@@ -15,7 +15,7 @@ import mediaquery from '@system.mediaquery';

 ## mediaquery.matchMedia

-matchMedia(condition: string): &lt;MediaQueryList&gt;
+matchMedia(condition: string): MediaQueryList

 根据媒体查询条件，创建MediaQueryList对象。

@@ -28,11 +28,10 @@ matchMedia(condition: string): &lt;MediaQueryList&gt;
 | condition | string | 是 | 用于查询的条件。 |

 **返回值：**
-**表1** MediaQueryList

-| 参数名 | 类型 | 说明 |
-| -------- | -------- | -------- |
-| MediaQueryList | Object | 表示创建MediaQueryList对象的属性，详情见下表 MediaQueryList说明。 |
+| 参数类型 | 说明 |
+| -------- | -------- |
+| MediaQueryList | 表示创建MediaQueryList对象的属性，详情见下表 MediaQueryList说明。 |

 **示例：**

@@ -44,18 +43,47 @@ export default {
 }
 ```

-  **表2** MediaQueryList说明
+## MediaQueryEvent

-| 参数名 | 类型 | 说明 |
-| -------- | -------- | -------- |
-| matches | boolean | 如果查询条件匹配成功则返回true，否则返回值为false。只读。 |
-| media | string | 序列化的媒体查询条件，只读。 |
-| onchange | Function | matches状态变化时的执行函数。 |
+定义MediaQuery事件。

+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| matches | boolean | 是 | 匹配结果。 |
+
+## MediaQueryList
+
+定义MediaQuery列表信息。
+
+### 属性
+
+**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full

-## MediaQueryList.addListener
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| media | string | 否 | 序列化媒体查询条件，该参数为只读。 |
+| matches | boolean | 是 | 匹配结果。 |
+
+### onchange
+
+onchange?: (matches: boolean) => void
+
+matches状态变化时的执行函数。

-addListener(Object): void
+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+**参数：**
+
+| 参数名 | 类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| matches | boolean | 是 | matches状态变化时值。 |
+
+
+### MediaQueryList.addListener
+
+addListener(callback: (event: MediaQueryEvent) => void): void

 给MediaQueryList添加回调函数，回调函数应在onShow生命周期之前添加，即需要在onInit或onReady生命周期里添加。

@@ -65,28 +93,18 @@ addListener(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| callback | Function | 是 | 匹配条件发生变化的响应函数。 |
+| callback | (event: MediaQueryEvent) => void | 是 | 匹配条件发生变化的响应函数。 |

 **示例：**

 ```
-export default {
-  onReady() {
-    var mMediaQueryList = mediaquery.matchMedia('(max-width: 466)');
-    function maxWidthMatch(e) {
-      if (e.matches) {
-        // do something
-      }
-    }
-    mMediaQueryList.addListener(maxWidthMatch);
-  },
-}
+mMediaQueryList.addListener(maxWidthMatch);
 ```


-## MediaQueryList.removeListener
+### MediaQueryList.removeListener

-removeListener(Object): void
+removeListener(callback: (event: MediaQueryEvent) => void): void

 移除MediaQueryList中的回调函数。

@@ -96,10 +114,14 @@ removeListener(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| callback | Function | 是 | 匹配条件发生变化的响应函数。 |
+| callback | (event: MediaQueryEvent) => void) | 是 | 匹配条件发生变化的响应函数。 |

 **示例：**

 ```
-query.removeListener(minWidthMatch);
-```
\ No newline at end of file
+mMediaQueryList.removeListener(maxWidthMatch);
+```
+
+
+
+
--- a/zh-cn/application-dev/reference/apis/js-apis-system-router.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-system-router.md
@@ -13,7 +13,7 @@ import router from '@system.router';

 ## router.push

-push(Object): void
+push(options: RouterOptions): void

 跳转到应用内的指定页面。

@@ -23,8 +23,7 @@ push(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| uri | string | 是 | 表示目标页面的uri，可以用以下两种格式：<br/>-&nbsp;页面绝对路径，由配置文件中pages列表提供，例如：<br/>&nbsp;&nbsp;-&nbsp;pages/index/index<br/>&nbsp;&nbsp;-&nbsp;pages/detail/detail<br/>-&nbsp;特殊值，如果uri的值是"/"，则跳转到首页。 |
-| params | Object | 否 | 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+| options | [RouterOptions](#routeroptions) | 是 | 页面路由参数，详细请参考RouterOptions。|

 **示例：**

@@ -68,7 +67,7 @@ export default {

 ## router.replace

-replace(Object): void
+replace(options: RouterOptions): void

 用应用内的某个页面替换当前页面，并销毁被替换的页面。

@@ -78,8 +77,7 @@ replace(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| uri | string | 是 | 目标页面的uri，可以是以下的两种格式：<br/>-&nbsp;页面绝对路径，由配置文件中pages列表提供，例如：<br/>&nbsp;&nbsp;-&nbsp;pages/index/index<br/>&nbsp;&nbsp;-&nbsp;pages/detail/detail<br/>-&nbsp;特殊值，如果uri的值是"/"，则跳转到首页。 |
-| params | Object | 否 | 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+| options | [RouterOptions](#routeroptions) | 是 | 页面路由参数，详细请参考RouterOptions。|

 **示例：**

@@ -112,7 +110,7 @@ export default {

 ## router.back

-back(Object): void
+back(options?: BackRouterOptions): void

 返回上一页面或指定的页面。

@@ -122,8 +120,7 @@ back(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| uri | string | 否 | 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。 |
-| params | Object | 否 | 跳转时要同时传递到目标页面的数据 |
+| options | [BackRouterOptions](#backrouteroptions) | 是 | 详细请参考BackRouterOptions。|

 **示例：**

@@ -183,6 +180,20 @@ export default {
 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
 > 示例中的uri字段是页面路由，由配置文件中的pages列表指定。

+## router.getParams
+
+getParams(): ParamsInterface
+
+获取当前页面的参数信息。
+
+**系统能力：** SystemCapability.ArkUI.ArkUI.Full
+
+**返回值：**
+
+| 类型 | 说明 |
+| -------- | -------- |
+| [ParamsInterface](#paramsinterface) | 详细请参见ParamsInterface。|
+
 ## router.clear

 clear(): void
@@ -228,20 +239,17 @@ export default {

 ## router.getState

-getState(): &lt;RouterState&gt;
+getState(): RouterState

 获取当前页面的状态信息。

 **系统能力：** SystemCapability.ArkUI.ArkUI.Full

 **返回值：**
-**表1** RouterState

-| 参数名 | 类型 | 说明 |
-| -------- | -------- | -------- |
-| index | number | 表示当前页面在页面栈中的索引。<br/>>&nbsp;![icon-note.gif](public_sys-resources/icon-note.gif)&nbsp;**说明：**<br/>>&nbsp;从栈底到栈顶，index从1开始递增。 |
-| name | string | 表示当前页面的名称，即对应文件名。 |
-| path | string | 表示当前页面的路径。 |
+| 参数类型 | 说明 |
+| -------- | -------- |
+| [RouterState](#routerstate) | 详细请参见RouterState。|

 **示例：**

@@ -258,7 +266,7 @@ export default {

 ## router.enableAlertBeforeBackPage<sup>6+</sup>

-enableAlertBeforeBackPage(Object): void
+enableAlertBeforeBackPage(options: EnableAlertBeforeBackPageOptions): void

 开启页面返回询问对话框。

@@ -268,10 +276,7 @@ enableAlertBeforeBackPage(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| message | string | 是 | 询问对话框内容。 |
-| success | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用成功的回调函数。 |
-| fail | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用失败的回调函数。 |
-| complete | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用结束的回调函数。 |
+| options | [EnableAlertBeforeBackPageOptions](#EnableAlertbeforebackpageoptions) | 是 | 详细请参见EnableAlertBeforeBackPageOptions。 |

 **示例：**

@@ -293,7 +298,7 @@ export default {

 ## router.disableAlertBeforeBackPage<sup>6+</sup>

-disableAlertBeforeBackPage(Object): void
+disableAlertBeforeBackPage(options?: DisableAlertBeforeBackPageOptions): void

 禁用页面返回询问对话框。

@@ -303,9 +308,7 @@ disableAlertBeforeBackPage(Object): void

 | 参数名 | 类型 | 必填 | 说明 |
 | -------- | -------- | -------- | -------- |
-| success | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用成功的回调函数。 |
-| fail | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用失败的回调函数。 |
-| complete | ()&nbsp;=&gt;&nbsp;void | 否 | 接口调用结束的回调函数。 |
+| options | [DisableAlertBeforeBackPageOptions](#disablealertbeforebackpageoptions)| 否 | 详细请参见DisableAlertBeforeBackPageOptions。 |

 **示例：**

@@ -324,3 +327,68 @@ export default {
 }
 ```

+## RouterOptions
+
+定义路由器的选项。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Lite
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| uri | string | 是 | 目标页面的uri，可以是以下的两种格式：<br/>1. 页面的绝对路径，由config.json文件中的页面列表提供。例如：<br/>- pages/index/index<br/> -pages/detail/detail<br/>2. 特定路径。如果URI为斜杠（/），则显示主页。 |
+| params | Object | 否 | 跳转时要同时传递到目标页面的数据，跳转到目标页面后，参数可以在页面中直接使用，如this.data1(data1为跳转时params参数中的key值)。如果目标页面中已有该字段，则其值会被传入的字段值覆盖。 |
+
+
+## BackRouterOptions
+
+定义路由器返回的选项。
+
+**系统能力：**  以下各项对应的系统能力有所不同，详见下表。
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| uri | string | 否 | 返回到指定uri的界面，如果页面栈上没有uri页面，则不响应该情况。如果uri未设置，则返回上一页。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Full|
+| params | Object | 否 | 跳转时要同时传递到目标页面的数据。 <br>**系统能力：** SystemCapability.ArkUI.ArkUI.Lite|
+
+## RouterState
+
+定义路由器的状态。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- |-------- |
+| index | number | 是 | 表示当前页面在页面栈中的索引。从栈底到栈顶，index从1开始递增。 |
+| name | string | 是 | 表示当前页面的名称，即对应文件名。 |
+| path | string | 是 | 表示当前页面的路径。 |
+
+## EnableAlertBeforeBackPageOptions<sup>6+</sup>
+
+定义EnableAlertBe beforeBackPage选项。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| message | string | 是 | 询问对话框内容。 |
+| success | (errMsg: string) => void | 否 | 弹出对话框时调用，errMsg表示返回信息。 |
+| fail | (errMsg: string) => void | 否 | 接口调用失败的回调函数，errMsg表示返回信息。 |
+| complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+## DisableAlertBeforeBackPageOptions<sup>6+</sup>
+
+定义DisableAlertBeforeBackPage参数选项。
+
+**系统能力：**  以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Full
+
+| 名称 | 参数类型 | 必填 | 说明 |
+| -------- | -------- | -------- | -------- |
+| success | (errMsg: string) => void | 否 | 弹出对话框时调用，errMsg表示返回信息。 |
+| fail | (errMsg: string) => void | 否 | 接口调用失败的回调函数，errMsg表示返回信息。|
+| complete | () => void | 否 | 接口调用结束的回调函数。 |
+
+## ParamsInterface
+
+| 名称 | 参数类型 | 说明 |
+| -------- | -------- | -------- |
+| [key: string] | Object| 路由参数列表。 |