提交 804b035e 编写于 作者: Z zhengjiangliang

废弃接口移动到最后

Change-Id: Idd6d443dd92334b39397ed909baeb7a0bc150914
Signed-off-by: Nzhengjiangliang <zhengjiangliang@huawei.com>
上级 dbad4708
......@@ -78,6 +78,14 @@ getDefaultDisplaySync(): Display
| ------------------------------| ----------------------------------------------|
| [Display](#display) | 返回默认的display对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -102,10 +110,20 @@ getAllDisplays(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
| -------- | ---------------------------------------------------- | ---- | ------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Display](#display)&gt;&gt; | 是 | 回调函数。返回当前所有的display对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
let displayClass = null;
display.getAllDisplays((err, data) => {
displayClass = data;
if (err.code) {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
return;
......@@ -128,11 +146,21 @@ getAllDisplays(): Promise&lt;Array&lt;Display&gt;&gt;
| ----------------------------------------------- | ------------------------------------------------------- |
| Promise&lt;Array&lt;[Display](#display)&gt;&gt; | Promise对象。返回当前所有的display对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
let displayClass = null;
let promise = display.getAllDisplays();
promise.then((data) => {
displayClass = data;
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}).catch((err) => {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
......@@ -143,7 +171,7 @@ promise.then((data) => {
hasPrivateWindow(displayId: number): boolean
查询指定display对象上是否有可见的隐私窗口。可通过[setPrivacyMode](js-apis-window.md#setprivacymode7)接口设置隐私窗口。隐私窗口内容将无法被截屏或录屏。
查询指定display对象上是否有可见的隐私窗口。可通过[setWindowPrivacyMode()](js-apis-window.md#setwindowprivacymode9)接口设置隐私窗口。隐私窗口内容将无法被截屏或录屏。
**系统接口:** 此接口为系统接口。
......@@ -161,6 +189,14 @@ hasPrivateWindow(displayId: number): boolean
| -------------------------------- |-----------------------------------------------------------------------|
|boolean | 查询的display对象上是否有可见的隐私窗口。<br>true表示此display对象上有可见的隐私窗口,false表示此display对象上没有可见的隐私窗口。</br> |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -247,6 +283,7 @@ getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
获取当前默认的display对象,使用callback异步回调。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[getDefaultDisplaySync()](#displaygetdefaultdisplaysync9)。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
......@@ -260,7 +297,7 @@ getDefaultDisplay(callback: AsyncCallback&lt;Display&gt;): void
**示例:**
```js
var displayClass = null;
let displayClass = null;
display.getDefaultDisplay((err, data) => {
if (err.code) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
......@@ -278,6 +315,7 @@ getDefaultDisplay(): Promise&lt;Display&gt;
获取当前默认的display对象,使用Promise异步回调。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[getDefaultDisplaySync()](#displaygetdefaultdisplaysync9)。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
......@@ -291,7 +329,7 @@ getDefaultDisplay(): Promise&lt;Display&gt;
**示例:**
```js
var displayClass = null;
let displayClass = null;
let promise = display.getDefaultDisplay();
promise.then((data) => {
displayClass = data;
......@@ -308,6 +346,7 @@ getAllDisplay(callback: AsyncCallback&lt;Array&lt;Display&gt;&gt;): void
获取当前所有的display对象,使用callback异步回调。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[getAllDisplays()](#displaygetalldisplays9)。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
......@@ -337,6 +376,7 @@ getAllDisplay(): Promise&lt;Array&lt;Display&gt;&gt;
获取当前所有的display对象,使用Promise异步回调。
> **说明:**
>
> 从 API version 7开始支持,从API version 9开始废弃,推荐使用[getAllDisplays()](#displaygetalldisplays9-1)。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
......@@ -361,7 +401,7 @@ promise.then((data) => {
## Display
屏幕实例。描述display对象的属性和方法。
下列API示例中都需先使用[getAllDisplay()](#displaygetalldisplay)[getDefaultDisplay()](#displaygetdefaultdisplay)[getDefaultDisplaySync()](#displaygetdefaultdisplaysync)中的任一方法获取到Display实例,再通过此实例调用对应方法。
下列API示例中都需先使用[getAllDisplays()](#displaygetalldisplays9)[getDefaultDisplaySync()](#displaygetdefaultdisplaysync9)中的任一方法获取到Display实例,再通过此实例调用对应方法。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core
......@@ -394,9 +434,23 @@ getCutoutInfo(callback: AsyncCallback&lt;CutoutInfo&gt;): void
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;[CutoutInfo](#cutoutinfo9)&gt; | 是 | 回调函数。当获取信息成功,err为undefined,data为获取到的CutoutInfo对象;否则err为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
try {
let displayClass = display.getDefaultDisplaySync();
} catch (exception) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
};
displayClass.getCutoutInfo((err, data) => {
if (err.code) {
console.error('Failed to get cutoutInfo. Code: ' + JSON.stringify(err));
......@@ -418,9 +472,23 @@ getCutoutInfo(): Promise&lt;CutoutInfo&gt;
| ------------------- | ------------------------- |
| Promise&lt;[CutoutInfo](#cutoutinfo9)&gt; | Promise对象,返回描述不可用屏幕区域的CutoutInfo对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
try {
let displayClass = display.getDefaultDisplaySync();
} catch (exception) {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(exception));
};
let promise = displayClass.getCutoutInfo();
promise.then((data) => {
console.info('Succeeded in getting cutoutInfo. Data: ' + JSON.stringify(data));
......
......@@ -28,6 +28,14 @@ getAllScreens(callback: AsyncCallback&lt;Array&lt;Screen&gt;&gt;): void
| -------- | --------------------------------------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback&lt;Array&lt;[Screen](#screen)&gt;&gt; | 是 | 回调函数。返回当前获取的屏幕对象集合。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -56,6 +64,14 @@ getAllScreens(): Promise&lt;Array&lt;Screen&gt;&gt;
| --------------------------------------------- | ----------------------------------------- |
| Promise&lt;Array&lt;[Screen](#screen)&gt;&gt; | Promise对象。返回当前获取的屏幕对象集合。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -140,6 +156,14 @@ makeExpand(options:Array&lt;ExpandOption&gt;, callback: AsyncCallback&lt;number&
| options | Array&lt;[ExpandOption](#expandoption)&gt; | 是 | 设置扩展屏幕的参数集合。 |
| callback | Callback&lt;number&gt; | 是 | 回调函数。返回扩展屏幕的群组id。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -178,6 +202,14 @@ makeExpand(options:Array&lt;ExpandOption&gt;): Promise&lt;number&gt;
| --------------------- | ----------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回扩展屏幕的群组id。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -208,6 +240,14 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;, callback: AsyncC
| mirrorScreen | Array&lt;number&gt; | 是 | 镜像屏幕id集合。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调函数。返回镜像屏幕的群组id。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -247,6 +287,14 @@ makeMirror(mainScreen:number, mirrorScreen:Array&lt;number&gt;): Promise&lt;numb
| --------------------- | ----------------------------------- |
| Promise&lt;number&gt; | Promise对象。返回镜像屏幕的群组id。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -280,6 +328,14 @@ createVirtualScreen(options:VirtualScreenOption, callback: AsyncCallback&lt;Scre
| options | [VirtualScreenOption](#virtualscreenoption) | 是 | 用于创建虚拟屏幕的参数。 |
| callback | AsyncCallback&lt;[Screen](#screen)&gt; | 是 | 回调函数,返回创建的虚拟屏幕对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -326,6 +382,14 @@ createVirtualScreen(options:VirtualScreenOption): Promise&lt;Screen&gt;
| -------------------------------- | ------------------------------------- |
| Promise&lt;[Screen](#screen)&gt; | Promise对象。返回创建的虚拟屏幕对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -363,6 +427,14 @@ destroyVirtualScreen(screenId:number, callback: AsyncCallback&lt;void&gt;): void
| screenId | number | 是 | 屏幕的id。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当销毁虚拟屏幕成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 1400002 | This operation is not access. |
**示例:**
```js
......@@ -400,6 +472,14 @@ destroyVirtualScreen(screenId:number): Promise&lt;void&gt;
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 1400002 | This operation is not access. |
**示例:**
```js
......@@ -433,6 +513,14 @@ setVirtualScreenSurface(screenId:number, surfaceId: string, callback: AsyncCallb
| surfaceId | string | 是 | surface的id。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当设置虚拟屏幕surface成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -474,6 +562,14 @@ setVirtualScreenSurface(screenId:number, surfaceId: string): Promise&lt;void&gt;
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 1400001 | This is invalid screen. |
**示例:**
```js
......@@ -662,6 +758,14 @@ setOrientation(orientation: Orientation, callback: AsyncCallback&lt;void&gt;): v
| orientation | [Orientation](#orientation) | 是 | 屏幕方向。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当设置屏幕方向成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -696,6 +800,14 @@ setOrientation(orientation: Orientation): Promise&lt;void&gt;
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -724,6 +836,14 @@ setScreenActiveMode(modeIndex: number, callback: AsyncCallback&lt;void&gt;): voi
| modeIndex | number | 是 | 模式索引。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当设置屏幕当前显示模式成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -759,6 +879,14 @@ setScreenActiveMode(modeIndex: number): Promise&lt;void&gt;
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -788,6 +916,14 @@ setDensityDpi(densityDpi: number, callback: AsyncCallback&lt;void&gt;): void;
| densityDpi | number | 是 | 像素密度。支持的输入范围为80-640。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。当设置屏幕的像素密度成功,err为undefined,否则为错误对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......@@ -823,6 +959,14 @@ setDensityDpi(densityDpi: number): Promise&lt;void&gt;
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见[屏幕错误码](../errorcodes/errorcode-display.md)
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 1400003 | This window manager service work abnormally. |
**示例:**
```js
......
# 屏幕错误码
## 1400001 无效虚拟屏
### 错误信息
This is invalid screen.
### 错误描述
当操作无效的虚拟屏时,会报此错误码。
### 可能原因
1. 虚拟屏未创建。
2. 虚拟屏已销毁。
### 处理步骤
1. 在操作虚拟屏前,检查该虚拟屏是否已经存在,确保已创建该虚拟屏。
2. 在操作虚拟屏前,检查虚拟屏是否已被销毁,确保其未被销毁,再进行相关操作。
## 1400002 无权限操作
### 错误信息
This operation is not access.
### 错误描述
当对无操作权限的对象进行操作时,会报此错误码。
### 可能原因
操作了其它进程的虚拟屏对象。
### 处理步骤
请检查是否非法操作了别的进程的对象,删除相关非法操作。
## 1400003 系统服务工作异常
### 错误信息
This window manager service work abnormally.
### 错误描述
当系统服务工作异常时,会报此错误码。
### 可能原因
1. 窗口内部服务没有正常启动。
2. 底层图形图像合成渲染异常。
### 处理步骤
系统服务内部工作异常,请稍候重试,或者重启设备尝试。
# 窗口错误码
## 1300001 重复操作
### 错误信息
This is repeat operation.
### 错误描述
当进行某些重复操作时,系统会报此错误码。
### 可能原因
创建的窗口已经存在时,再次创建该窗口会报错。
### 处理步骤
在创建窗口前,检查该窗口是否已经存在,确保为首次创建该窗口。
## 1300002 窗口状态异常
### 错误信息
This window state is abnormal.
### 错误描述
当窗口状态异常,如已被销毁时,操作该窗口,会报此错误码。
### 可能原因
操作窗口时,该窗口已被销毁。
### 处理步骤
在对窗口进行操作前,检查该窗口是否存在,确保其未被销毁,再进行相关操作。
## 1300003 系统服务工作异常
### 错误信息
This window manager service work abnormally.
### 错误描述
当系统服务工作异常时,会报此错误码。
### 可能原因
窗口内部服务没有正常启动。
### 处理步骤
系统服务内部工作异常,请稍候重试,或者重启设备尝试。
## 1300004 无权限操作
### 错误信息
This operation is not access.
### 错误描述
当对无操作权限的对象进行操作时,会报此错误码。
### 可能原因
操作了其它进程的窗口对象。
### 处理步骤
请检查是否非法操作了别的进程的对象,删除相关操作。
## 1300005 WindowStage异常
### 错误信息
This window stage is abnormal.
### 错误描述
当WindowStage异常,如已被销毁时,操作该WindowStage,会报此错误码。
### 可能原因
操作WindowStage时,该WindowStage已被销毁。
### 处理步骤
在对WindowStage进行操作前,检查该WindowStage是否存在,若已被销毁,请释放该WindowStage下的窗口。
## 1300006 窗口上下文异常
### 错误信息
This window context is abnormal.
### 错误描述
当窗口上下文异常,如已被销毁时,操作该窗口上下文,会报此错误码。
### 可能原因
操作窗口上下文时,该窗口上下文已被销毁。
### 处理步骤
在对窗口上下文进行操作前,检查该窗口上下文是否存在,确保其未被销毁,再进行相关操作。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册