From bffc948101e0d25c2ab5b1c1194c6ad7a7745f2d Mon Sep 17 00:00:00 2001 From: xpeng Date: Thu, 30 Jun 2022 17:08:16 +0800 Subject: [PATCH] Add doc for screen.md Signed-off-by: xpeng Change-Id: I4bd80aa503d427227d2086ede2298730f69adf91 --- .../reference/apis/js-apis-screen.md | 101 ++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-screen.md b/zh-cn/application-dev/reference/apis/js-apis-screen.md index 22cee94009..cd95e31437 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-screen.md +++ b/zh-cn/application-dev/reference/apis/js-apis-screen.md @@ -393,6 +393,107 @@ screen.setVirtualScreenSurface(screenId, surfaceId).then((data) => { console.error('Failed to Set surface for the virtual screen.Cause:' + JSON.stringify(err)); }); ``` + +## screen.isScreenRotationLocked +isScreenRotationLocked(): Promise<boolean> + +查询当前自动转屏是否锁定,使用Promise异步回调。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**返回值:** +| 类型 | 说明 | +| ---------------------- | ------------------------------------- | +| Promise<boolean> | Promise对象。返回当前自动转屏是否处于锁定状态 | + +**示例:** +```js +screen.isScreenRotationLocked().then((isLocked) => { + console.info('Succeeded in getting screen rotation lock status. isLocked:'+ JSON.stringify(isLocked)); +}).catch((err) => { + console.error('Failed to get screen rotation lock status. Cause:' + JSON.stringify(err)); +}); +``` + +## screen.isScreenRotationLocked +isScreenRotationLocked(callback: AsyncCallback<boolean>): void + +查询当前自动转屏是否锁定,使用callback异步回调。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ---------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<boolean> | 是 | 回调函数。当查询自动转屏锁定状态成功,err为undefined,否则为错误对象。 | + +**示例:** + +```js +screen.isScreenRotationLocked((err, isLocked) => { + if (err.code) { + console.error('Failed to get screen rotation lock status. Cause:' + JSON.stringify(err)); + return; + } + console.info('Succeeded in getting screen rotation lock status. isLocked:' + JSON.stringify(isLocked)); +}); +``` + +## screen.setScreenRotationLocked +setScreenRotationLocked(isLocked: boolean): Promise<void> + +设置自动转屏开关是否锁定,使用Promise异步回调。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**参数:** +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ------------- | +| isLocked | boolean | 是 | 自动转屏开关是否锁定。true为锁定,false为未锁定. | + +**返回值:** +| 类型 | 说明 | +| ------------------- | ------------------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例:** +```js +var isLocked = false; +screen.setScreenRotationLocked(isLocked).then((data) => { + console.info('Succeeded in setting whether to lock screen rotation'); +}).catch((err) => { + console.error('Failed to set whether to lock screen rotation. Cause:' + JSON.stringify(err)); +}); +``` + +## screen.setScreenRotationLocked +setScreenRotationLocked(isLocked: boolean, callback: AsyncCallback<void>): void + +设置自动转屏开关是否锁定,使用callback异步回调。 + +**系统能力:** SystemCapability.WindowManager.WindowManager.Core + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------------------------- | ---- | ------------------------------------------------------------ | +| isLocked | boolean | 是 | 自动转屏开关是否锁定。true为锁定,false为未锁定. | +| callback | AsyncCallback<void> | 是 | 回调函数。当设置自动转屏是否锁定成功,err为undefined,否则为错误对象。 | + +**示例:** + +```js +var isLocked = false; +screen.setScreenRotationLocked(isLocked, (err, data) => { + if (err.code) { + console.error('Failed to set whether to lock screen rotation. Cause:' + JSON.stringify(err)); + return; + } + console.info('Succeeded in setting whether to lock screen rotation.'); +}); +``` + ## ExpandOption 扩展屏幕的参数。 -- GitLab