From 305348edd067a6989a2e92ee8f60f7d998f7f52b Mon Sep 17 00:00:00 2001 From: LiAn Date: Wed, 23 Mar 2022 06:47:50 +0000 Subject: [PATCH] update zh-cn/application-dev/reference/apis/js-apis-system-app.md. Signed-off-by: LiAn --- .../reference/apis/js-apis-system-app.md | 131 +++++++++++------- 1 file changed, 84 insertions(+), 47 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-app.md b/zh-cn/application-dev/reference/apis/js-apis-system-app.md index 6ceb384650..26c5b105b4 100644 --- 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(): <AppResponse> +getInfo(): AppResponse 获取当前应用配置文件中声明的信息。 **系统能力：** SystemCapability.ArkUI.ArkUI.Lite **返回值：** -**表1** AppResponse -| 参数名 | 类型 | 说明 | -| -------- | -------- | -------- | -| appID6+ | string | 表示应用的包名，用于标识应用的唯一性。 | -| appName | string | 表示应用的名称。 | -| versionName | string | 表示应用的版本名称。 | -| versionCode | number | 表示应用的版本号。 | +| 参数类型 | 说明 | +| -------- | -------- | +| [AppResponse](#appresponse) | 定义AppResponse信息。 | **示例：** @@ -43,41 +39,6 @@ getInfo(): <AppResponse> } ``` -## 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信息。 + +**系统能力：** 以下各项对应的系统能力有所不同，详见下表。 + +| 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- |-------- | +| appID6+ | string | 是 | 表示应用的包名，用于标识应用的唯一性。
**系统能力：** SystemCapability.ArkUI.ArkUI.Full| +| appName | string | 是 | 表示应用的名称。
**系统能力：** SystemCapability.ArkUI.ArkUI.Lite| +| versionName | string | 是 | 表示应用的版本名称。
**系统能力：** SystemCapability.ArkUI.ArkUI.Lite| +| versionCode | number | 是 | 表示应用的版本号。
**系统能力：** 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 | 是 | 定义动画选项的数量。 | + -- GitLab