Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
972b0f80
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
972b0f80
编写于
8月 11, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 11, 2022
浏览文件
操作
浏览文件
下载
差异文件
!7982 master - API样板化:统一系统接口及模型约束:需同步翻译
Merge pull request !7982 from 葛亚芳/master
上级
870f2d8d
f47e7977
变更
3
展开全部
隐藏空白更改
内联
并排
Showing
3 changed file
with
162 addition
and
153 deletion
+162
-153
zh-cn/application-dev/reference/apis/js-apis-display.md
zh-cn/application-dev/reference/apis/js-apis-display.md
+66
-57
zh-cn/application-dev/reference/apis/js-apis-usb.md
zh-cn/application-dev/reference/apis/js-apis-usb.md
+13
-13
zh-cn/application-dev/reference/apis/js-apis-window.md
zh-cn/application-dev/reference/apis/js-apis-window.md
+83
-83
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @
972b0f80
...
@@ -74,22 +74,24 @@ getDefaultDisplay(callback: AsyncCallback<Display>): void
...
@@ -74,22 +74,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
...
@@ -107,14 +109,16 @@ getDefaultDisplay(): Promise<Display>
...
@@ -107,14 +109,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.getDefaultDisplaySync<sup>9+</sup>
## display.getDefaultDisplaySync<sup>9+</sup>
...
@@ -152,15 +156,15 @@ getAllDisplay(callback: AsyncCallback<Array<Display>>): void
...
@@ -152,15 +156,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
...
@@ -178,14 +182,14 @@ getAllDisplay(): Promise<Array<Display>>
...
@@ -178,14 +182,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.hasPrivateWindow<sup>9+</sup>
## display.hasPrivateWindow<sup>9+</sup>
...
@@ -193,7 +197,7 @@ hasPrivateWindow(displayId: number): boolean
...
@@ -193,7 +197,7 @@ hasPrivateWindow(displayId: number): boolean
查询指定display对象上是否有可见的隐私窗口。可通过
[
setPrivacyMode
](
js-apis-window.md#setprivacymode7
)
接口设置隐私窗口。隐私窗口内容将无法被截屏或录屏。
查询指定display对象上是否有可见的隐私窗口。可通过
[
setPrivacyMode
](
js-apis-window.md#setprivacymode7
)
接口设置隐私窗口。隐私窗口内容将无法被截屏或录屏。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
...
@@ -211,17 +215,17 @@ hasPrivateWindow(displayId: number): boolean
...
@@ -211,17 +215,17 @@ hasPrivateWindow(displayId: number): boolean
**示例:**
**示例:**
```
js
```
js
var
ret
=
display
.
hasPrivateWindow
(
displayClass
.
id
);
var
ret
=
display
.
hasPrivateWindow
(
displayClass
.
id
);
if
(
ret
==
undefined
)
{
if
(
ret
==
undefined
)
{
console
.
log
(
"
HasPrivateWindow undefined
.
"
);
console
.
log
(
"
Failed to check has privateWindow or not
.
"
);
}
}
if
(
ret
)
{
if
(
ret
)
{
console
.
log
(
"
HasP
rivateWindow.
"
);
console
.
log
(
"
There has p
rivateWindow.
"
);
}
else
if
(
!
ret
)
{
}
else
if
(
!
ret
)
{
console
.
log
(
"
Don't HasP
rivateWindow.
"
);
console
.
log
(
"
There has no p
rivateWindow.
"
);
}
}
```
```
## display.on('add'|'remove'|'change')
## display.on('add'|'remove'|'change')
...
@@ -232,19 +236,20 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
...
@@ -232,19 +236,20 @@ on(type: 'add'|'remove'|'change', callback: Callback<number>): void
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。
<br/>
- type为"remove",表示移除显示设备事件。
<br/>
- type为"change",表示改变显示设备事件。 |
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。
<br/>
- type为"remove",表示移除显示设备事件。
<br/>
- type为"change",表示改变显示设备事件。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的id。 |
| callback | Callback
<
number
>
| 是 | 回调函数。返回监听到的显示设备的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')
...
@@ -255,16 +260,17 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void
...
@@ -255,16 +260,17 @@ off(type: 'add'|'remove'|'change', callback?: Callback<number>): void
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。
<br/>
- type为"remove",表示移除显示设备事件。
<br/>
- type为"change",表示改变显示设备事件。 |
| type | string | 是 | 监听事件。
<br/>
- type为"add",表示增加显示设备事件。
<br/>
- type为"remove",表示移除显示设备事件。
<br/>
- type为"change",表示改变显示设备事件。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回监听到的显示设备的id。 |
| callback | Callback
<
number
>
| 否 | 回调函数。返回监听到的显示设备的id。 |
**示例:**
**示例:**
```
js
display
.
off
(
"
remove
"
);
```
```
js
display
.
off
(
"
remove
"
);
```
## Display
## Display
屏幕实例。描述display对象的属性和方法。
屏幕实例。描述display对象的属性和方法。
...
@@ -301,6 +307,7 @@ getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void
...
@@ -301,6 +307,7 @@ getCutoutInfo(callback: AsyncCallback<CutoutInfo>): void
| callback | AsyncCallback
<
[CutoutInfo](#cutoutinfo9)
>
| 是 | 回调函数。当获取信息成功,err为undefined,data为获取到的CutoutInfo对象;否则err为错误对象。 |
| callback | AsyncCallback
<
[CutoutInfo](#cutoutinfo9)
>
| 是 | 回调函数。当获取信息成功,err为undefined,data为获取到的CutoutInfo对象;否则err为错误对象。 |
**示例:**
**示例:**
```
js
```
js
displayClass
.
getCutoutInfo
((
err
,
data
)
=>
{
displayClass
.
getCutoutInfo
((
err
,
data
)
=>
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
...
@@ -318,11 +325,13 @@ getCutoutInfo(): Promise<CutoutInfo>
...
@@ -318,11 +325,13 @@ getCutoutInfo(): Promise<CutoutInfo>
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**系统能力:**
SystemCapability.WindowManager.WindowManager.Core
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型 | 说明 |
| ------------------- | ------------------------- |
| ------------------- | ------------------------- |
| Promise
<
[CutoutInfo](#cutoutinfo9)
>
| Promise对象,返回描述不可用屏幕区域的CutoutInfo对象。 |
| Promise
<
[CutoutInfo](#cutoutinfo9)
>
| Promise对象,返回描述不可用屏幕区域的CutoutInfo对象。 |
**示例:**
**示例:**
```
js
```
js
let
promise
=
displayClass
.
getCutoutInfo
();
let
promise
=
displayClass
.
getCutoutInfo
();
promise
.
then
((
data
)
=>
{
promise
.
then
((
data
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-usb.md
浏览文件 @
972b0f80
...
@@ -428,7 +428,7 @@ usbFunctionsFromString(funcs: string): number
...
@@ -428,7 +428,7 @@ usbFunctionsFromString(funcs: string): number
在设备模式下,将字符串形式的usb功能列表转化为数字掩码。
在设备模式下,将字符串形式的usb功能列表转化为数字掩码。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -457,7 +457,7 @@ usbFunctionsToString(funcs: FunctionType): string
...
@@ -457,7 +457,7 @@ usbFunctionsToString(funcs: FunctionType): string
在设备模式下,将数字掩码形式的usb功能列表转化为字符串。
在设备模式下,将数字掩码形式的usb功能列表转化为字符串。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -486,7 +486,7 @@ setCurrentFunctions(funcs: FunctionType): Promise\<boolean\>
...
@@ -486,7 +486,7 @@ setCurrentFunctions(funcs: FunctionType): Promise\<boolean\>
在设备模式下,设置当前的USB功能列表。
在设备模式下,设置当前的USB功能列表。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -515,7 +515,7 @@ getCurrentFunctions(): FunctionType
...
@@ -515,7 +515,7 @@ getCurrentFunctions(): FunctionType
在设备模式下,获取当前的USB功能列表的数字组合掩码。
在设备模式下,获取当前的USB功能列表的数字组合掩码。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -537,7 +537,7 @@ getPorts(): Array\<USBPort\>
...
@@ -537,7 +537,7 @@ getPorts(): Array\<USBPort\>
获取所有物理USB端口描述信息。
获取所有物理USB端口描述信息。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -559,7 +559,7 @@ getSupportedModes(portId: number): PortModeType
...
@@ -559,7 +559,7 @@ getSupportedModes(portId: number): PortModeType
获取指定的端口支持的模式列表的组合掩码。
获取指定的端口支持的模式列表的组合掩码。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -587,7 +587,7 @@ setPortRoles(portId: number, powerRole: PowerRoleType, dataRole: DataRoleType):
...
@@ -587,7 +587,7 @@ setPortRoles(portId: number, powerRole: PowerRoleType, dataRole: DataRoleType):
设置指定的端口支持的角色模式,包含充电角色、数据传输角色。
设置指定的端口支持的角色模式,包含充电角色、数据传输角色。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力:**
SystemCapability.USB.USBManager
**系统能力:**
SystemCapability.USB.USBManager
...
@@ -712,7 +712,7 @@ USB设备消息传输通道,用于确定设备。
...
@@ -712,7 +712,7 @@ USB设备消息传输通道,用于确定设备。
USB设备端口。
USB设备端口。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
@@ -726,7 +726,7 @@ USB设备端口。
...
@@ -726,7 +726,7 @@ USB设备端口。
USB设备端口角色信息。
USB设备端口角色信息。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
@@ -776,7 +776,7 @@ USB设备端口角色信息。
...
@@ -776,7 +776,7 @@ USB设备端口角色信息。
USB设备侧功能。
USB设备侧功能。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
@@ -797,7 +797,7 @@ USB设备侧功能。
...
@@ -797,7 +797,7 @@ USB设备侧功能。
USB端口模式类型。
USB端口模式类型。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
@@ -813,7 +813,7 @@ USB端口模式类型。
...
@@ -813,7 +813,7 @@ USB端口模式类型。
电源角色类型。
电源角色类型。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
@@ -827,7 +827,7 @@ USB端口模式类型。
...
@@ -827,7 +827,7 @@ USB端口模式类型。
数据角色类型。
数据角色类型。
此接口为系统接口。
**系统接口:**
此接口为系统接口。
**系统能力**
:SystemCapability.USB.USBManager
**系统能力**
:SystemCapability.USB.USBManager
...
...
zh-cn/application-dev/reference/apis/js-apis-window.md
浏览文件 @
972b0f80
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录