未验证 提交 5283a6b7 编写于 作者: O openharmony_ci 提交者: Gitee

!7984 3.1Release分支 - API样板化:统一系统接口及模型约束:需同步翻译

Merge pull request !7984 from 葛亚芳/OpenHarmony-3.1-Release
...@@ -61,22 +61,24 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void ...@@ -61,22 +61,24 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| callback | AsyncCallback<[Display](#display)> | 是 | 回调函数。返回当前默认的display对象。 | | callback | AsyncCallback<[Display](#display)> | 是 | 回调函数。返回当前默认的display对象。 |
**示例:** **示例:**
```js
var displayClass = null; ```js
display.getDefaultDisplay((err, data) => { var displayClass = null;
if (err.code) { display.getDefaultDisplay((err, data) => {
console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err)); if (err.code) {
return; console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
} return;
console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data)); }
displayClass = data; console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
}); displayClass = data;
``` });
```
## display.getDefaultDisplay ## display.getDefaultDisplay
...@@ -94,14 +96,16 @@ getDefaultDisplay(): Promise<Display> ...@@ -94,14 +96,16 @@ getDefaultDisplay(): Promise<Display>
**示例:** **示例:**
```js ```js
let promise = display.getDefaultDisplay(); var displayClass = null;
promise.then(() => { let promise = display.getDefaultDisplay();
console.log('getDefaultDisplay success'); promise.then((data) => {
}).catch((err) => { displayClass = data;
console.log('getDefaultDisplay fail: ' + JSON.stringify(err)); console.info('Succeeded in obtaining the default display object. Data:' + JSON.stringify(data));
}); }).catch((err) => {
``` console.error('Failed to obtain the default display object. Code: ' + JSON.stringify(err));
});
```
## display.getAllDisplay ## display.getAllDisplay
...@@ -119,15 +123,15 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void ...@@ -119,15 +123,15 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void
**示例:** **示例:**
```js ```js
display.getAllDisplay((err, data) => { display.getAllDisplay((err, data) => {
if (err.code) { if (err.code) {
console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err)); console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
return; return;
} }
console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data)) console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}); });
``` ```
## display.getAllDisplay ## display.getAllDisplay
...@@ -145,14 +149,14 @@ getAllDisplay(): Promise<Array<Display>> ...@@ -145,14 +149,14 @@ getAllDisplay(): Promise<Array<Display>>
**示例:** **示例:**
```js ```js
let promise = display.getAllDisplay(); let promise = display.getAllDisplay();
promise.then(() => { promise.then((data) => {
console.log('getAllDisplay success'); console.error('Failed to obtain all the display objects. Code: ' + JSON.stringify(err));
}).catch((err) => { }).catch((err) => {
console.log('getAllDisplay fail: ' + JSON.stringify(err)); console.info('Succeeded in obtaining all the display objects. Data: ' + JSON.stringify(data));
}); });
``` ```
## display.on('add'|'remove'|'change') ## display.on('add'|'remove'|'change')
...@@ -163,19 +167,20 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void ...@@ -163,19 +167,20 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add",表示监听增加显示设备。<br/>-&nbsp;type为"remove",表示监听移除显示设备。<br/>-&nbsp;type为"change",表示监听改变显示设备。 | | type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add",表示监听增加显示设备。<br/>-&nbsp;type为"remove",表示监听移除显示设备。<br/>-&nbsp;type为"change",表示监听改变显示设备。 |
| callback | Callback&lt;number&gt; | 是 | 回调函数。返回监听到的显示设备的id。 | | callback | Callback&lt;number&gt; | 是 | 回调函数。返回监听到的显示设备的id。 |
**示例:** **示例:**
```js
var callback = (data) => {
console.info('Listening enabled. Data: ' + JSON.stringify(data))
}
display.on("add", callback);
```
```js
var callback = (data) => {
console.info('Listening enabled. Data: ' + JSON.stringify(data))
}
display.on("add", callback);
```
## display.off('add'|'remove'|'change') ## display.off('add'|'remove'|'change')
...@@ -186,12 +191,13 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void ...@@ -186,12 +191,13 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add",表示监听增加显示设备。<br/>-&nbsp;type为"remove",表示监听移除显示设备。<br/>-&nbsp;type为"change",表示监听改变显示设备。 | | type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add",表示监听增加显示设备。<br/>-&nbsp;type为"remove",表示监听移除显示设备。<br/>-&nbsp;type为"change",表示监听改变显示设备。 |
| callback | Callback&lt;number&gt; | 否 | 回调函数。返回监听到的显示设备的id。 | | callback | Callback&lt;number&gt; | 否 | 回调函数。返回监听到的显示设备的id。 |
**示例:** **示例:**
```js ```js
display.off("remove"); display.off("remove");
``` ```
...@@ -44,7 +44,7 @@ import window from '@ohos.window'; ...@@ -44,7 +44,7 @@ import window from '@ohos.window';
窗口模式枚举。 窗口模式枚举。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -75,7 +75,7 @@ import window from '@ohos.window'; ...@@ -75,7 +75,7 @@ import window from '@ohos.window';
单个导航栏或状态栏回调信息。 单个导航栏或状态栏回调信息。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -91,7 +91,7 @@ import window from '@ohos.window'; ...@@ -91,7 +91,7 @@ import window from '@ohos.window';
当前系统栏回调信息集合。 当前系统栏回调信息集合。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -486,7 +486,7 @@ on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): v ...@@ -486,7 +486,7 @@ on(type: 'systemBarTintChange', callback: Callback&lt;SystemBarTintState&gt;): v
开启状态栏、导航栏属性变化的监听。 开启状态栏、导航栏属性变化的监听。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -511,7 +511,7 @@ off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;) ...@@ -511,7 +511,7 @@ off(type: 'systemBarTintChange', callback?: Callback&lt;SystemBarTintState &gt;)
关闭状态栏、导航栏属性变化的监听。 关闭状态栏、导航栏属性变化的监听。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -540,7 +540,7 @@ hide (callback: AsyncCallback&lt;void&gt;): void ...@@ -540,7 +540,7 @@ hide (callback: AsyncCallback&lt;void&gt;): void
隐藏当前窗口,使用callback异步回调。 隐藏当前窗口,使用callback异步回调。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -568,7 +568,7 @@ hide(): Promise&lt;void&gt; ...@@ -568,7 +568,7 @@ hide(): Promise&lt;void&gt;
隐藏当前窗口,使用Promise异步回调。 隐藏当前窗口,使用Promise异步回调。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -818,7 +818,7 @@ setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void ...@@ -818,7 +818,7 @@ setWindowType(type: WindowType, callback: AsyncCallback&lt;void&gt;): void
设置窗口类型,使用callback异步回调。 设置窗口类型,使用callback异步回调。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
...@@ -848,7 +848,7 @@ setWindowType(type: WindowType): Promise&lt;void&gt; ...@@ -848,7 +848,7 @@ setWindowType(type: WindowType): Promise&lt;void&gt;
设置窗口类型,使用Promise异步回调。 设置窗口类型,使用Promise异步回调。
此接口为系统接口,三方应用不支持调用。 **系统接口:** 此接口为系统接口,三方应用不支持调用。
**系统能力:** SystemCapability.WindowManager.WindowManager.Core **系统能力:** SystemCapability.WindowManager.WindowManager.Core
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册