Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d23f2462
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看板
未验证
提交
d23f2462
编写于
7月 30, 2022
作者:
O
openharmony_ci
提交者:
Gitee
7月 30, 2022
浏览文件
操作
浏览文件
下载
差异文件
!7405 修订无障碍&系统参数接口文档
Merge pull request !7405 from Mupceet/fix-ax-doc
上级
64e7a410
30b4e3df
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
50 addition
and
64 deletion
+50
-64
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
...n/application-dev/reference/apis/js-apis-accessibility.md
+43
-53
zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md
...apis/js-apis-application-AccessibilityExtensionAbility.md
+6
-10
zh-cn/application-dev/reference/apis/js-apis-system-parameter.md
...pplication-dev/reference/apis/js-apis-system-parameter.md
+1
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @
d23f2462
...
...
@@ -146,6 +146,8 @@ import accessibility from '@ohos.accessibility';
字幕配置。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Hearing
### 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
...
...
@@ -153,26 +155,22 @@ import accessibility from '@ohos.accessibility';
| enabled | boolean | 是 | 否 | 表示是否启用字幕配置。 |
| style |
[
CaptionsStyle
](
#captionsstyle8
)
| 是 | 否 | 表示字幕风格。 |
### 方法
下列 API 示例中都需要使用
[
accessibility.getCaptionsManager()
](
#accessibilitygetcaptionsmanager8
)
获取 captionsManager 实例,再通过此实例调用对应的方法。
###
#
on('enableChange')
### on('enableChange')
on(type: 'enableChange', callback: Callback
<
boolean
>
): void;
注册字幕配置启用的监听函数。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Hearing
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听字幕配置启用状态。 |
| callback | Callback
<
boolean
>
| 是 | 回调函数,在启用状态变化时将状态通过此函数进行通知。 |
-
示例
-
**示例:**
```
typescript
captionsManager
.
on
(
'
enableChange
'
,(
data
)
=>
{
...
...
@@ -180,22 +178,20 @@ on(type: 'enableChange', callback: Callback<boolean>): void;
})
```
###
#
on('styleChange')
### on('styleChange')
on(type: 'styleChange', callback: Callback
<
CaptionsStyle
>
): void;
注册字幕风格变化的监听函数。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Hearing
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听字幕风格变化。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 是 | 回调函数,在字幕风格变化时通过此函数进行通知。 |
-
示例
-
**示例:**
```
typescript
captionsManager
.
on
(
'
styleChange
'
,(
data
)
=>
{
...
...
@@ -203,43 +199,39 @@ on(type: 'styleChange', callback: Callback<CaptionsStyle>): void;
})
```
###
#
off('enableChange')
### off('enableChange')
off(type: 'enableChange', callback?: Callback
<
boolean
>
): void;
移除字幕配置启用的监听函数。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Hearing
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听字幕配置启用状态。 |
| callback | Callback
<
boolean
>
| 否 | 回调函数,在启用状态变化时将状态通过此函数进行通知。 |
-
示例
-
**示例:**
```
typescript
captionsManager
.
off
(
'
enableChange
'
)
```
###
#
off('styleChange')
### off('styleChange')
off(type: 'styleChange', callback?: Callback
<
CaptionsStyle
>
): void;
移除字幕风格变化的监听函数。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Hearing
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 字幕风格变化。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 否 | 回调函数,在字幕风格变化时通过此函数进行通知。 |
-
示例
-
**示例:**
```
typescript
captionsManager
.
off
(
'
styleChange
'
)
...
...
@@ -270,21 +262,19 @@ off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void;
| endIndex | number | 是 | 是 | 画面显示条目的结束序号。 |
| itemCount | number | 是 | 是 | 条目总数。 |
### 方法
#### constructor
### constructor
constructor(jsonObject)
构造函数。
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| jsonObject | string | 是 | 创建对象所需要的 JSON 格式字符串。 |
-
示例
-
**示例:**
```
typescript
let
eventInfo
=
new
accessibility
.
EventInfo
({
"
type
"
:
"
click
"
,
"
bundleName
"
:
"
com.example.MyApplication
"
,
"
triggerAction
"
:
"
click
"
})
...
...
@@ -346,20 +336,20 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<A
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是 | 辅助应用的类型。 |
| stateType |
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。 |
-
返回值:
-
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 返回辅助应用信息列表。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
getAbilityLists
(
"
spoken
"
,
"
enable
"
)
...
...
@@ -389,7 +379,7 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
...
...
@@ -397,7 +387,7 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
| stateType |
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。 |
| callback | AsyncCallback
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 是 | 回调函数,返回辅助应用信息列表。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
getAbilityLists
(
"
visual
"
,
"
enable
"
,
(
err
,
data
)
=>
{
...
...
@@ -428,13 +418,13 @@ getCaptionsManager(): CaptionsManager
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Hearing
-
返回值:
-
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
CaptionsManager
](
#captionsmanager8
)
| 无障碍字幕配置管理。 |
-
示例
-
**示例:**
```
typescript
captionsManager
=
accessibility
.
getCaptionsManager
()
...
...
@@ -448,14 +438,14 @@ on(type: 'accessibilityStateChange' | 'touchGuideStateChange', callback: Callbac
**系统能力**
:以下各项对应的系统能力有所不同,详见下表。
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听的事件类型。
<br/>
-
type 为'accessibilityStateChange'时表示监听类型为辅助功能启用状态变化监听;
<br/>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
<br/>
-
type 为'touchGuideStateChange'时表示监听类型为触摸浏览启用状态变化监听。
<br/>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Vision |
| callback | Callback
<
boolean
>
| 是 | 回调函数,在启用状态变化时将状态通过此函数进行通知。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
on
(
'
accessibilityStateChange
'
,(
data
)
=>
{
...
...
@@ -471,14 +461,14 @@ off(type: ‘accessibilityStateChange ’ | ‘touchGuideStateChange’, callbac
**系统能力**
:以下各项对应的系统能力有所不同,详见下表。
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 否 | 监听的事件类型。
<br/>
-
type 为'accessibilityStateChange'时表示监听类型为辅助功能启用状态变化监听;
<br/>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
<br/>
-
type 为'touchGuideStateChange'时表示监听类型为触摸浏览启用状态变化监听。
<br/>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Vision |
| callback | Callback
<
boolean
>
| 否 | 要取消的监听回调函数。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
off
(
'
accessibilityStateChange
'
,(
data
)
=>
{
...
...
@@ -494,13 +484,13 @@ isOpenAccessibility(): Promise<boolean>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
返回值:
-
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 如果辅助功能已启用,则返回 true;否则返回 false。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
isOpenAccessibility
()
...
...
@@ -519,13 +509,13 @@ isOpenAccessibility(callback: AsyncCallback<boolean>): void
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
参数
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,如果辅助功能已启用,则返回 true;否则返回 false。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
isOpenAccessibility
((
err
,
data
)
=>
{
...
...
@@ -543,15 +533,15 @@ isOpenTouchGuide(): Promise<boolean>
判断触摸浏览模式是否开启。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.
Core
**系统能力**
:SystemCapability.BarrierFree.Accessibility.
Vision
-
返回值:
-
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 如果触摸浏览模式已开启,则返回 true;否则返回 false。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
isOpenTouchGuide
()
...
...
@@ -568,15 +558,15 @@ isOpenTouchGuide(callback: AsyncCallback<boolean>): void
判断触摸浏览模式是否开启。
**系统能力**
:SystemCapability.BarrierFree.Accessibility.
Core
**系统能力**
:SystemCapability.BarrierFree.Accessibility.
Vision
-
参数
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,如果触摸浏览模式已开启,则返回 true;否则返回 false。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
isOpenTouchGuide
((
err
,
data
)
=>
{
...
...
@@ -596,19 +586,19 @@ sendEvent(event: EventInfo): Promise<void>
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是 | 无障碍事件对象。 |
-
返回值:
-
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 以 Promise 形式返回结果,如果发送无障碍事件成功,则 data 有数据返回;如果发送无障碍事件失败,则 err 有数据返回。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
sendEvent
(
this
.
eventInfo
)
...
...
@@ -627,14 +617,14 @@ sendEvent(event: EventInfo, callback: AsyncCallback<void>): void
**系统能力**
:SystemCapability.BarrierFree.Accessibility.Core
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是 | 辅助事件对象。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,如果发送无障碍事件成功,则 AsyncCallback 中 data 有数据返回;如果发送无障碍事件失败,则 AsyncCallback 中 err 有数据返回。 |
-
示例
-
**示例:**
```
typescript
accessibility
.
sendEvent
(
this
.
eventInfo
,(
err
,
data
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-application-AccessibilityExtensionAbility.md
浏览文件 @
d23f2462
...
...
@@ -41,21 +41,19 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
| points | Array
<
[GesturePoint](gesturepoint)
>
| 是 | 是 | 手势。 |
| durationTime | number | 是 | 是 | 手势总耗时。 |
### 方法
#### constructor
### constructor
constructor(durationTime: number)
构造函数。
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| ------------ | ------ | ---- | ------ |
| durationTime | number | 是 | 手势总耗时。 |
-
示例
-
**示例:**
```
typescript
let
gesturePath
=
new
GesturePath
(
100
);
...
...
@@ -74,22 +72,20 @@ constructor(durationTime: number)
| positionX | number | 是 | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 是 | 触摸点Y坐标。 |
### 方法
#### constructor
### constructor
constructor(positionX: number, positionY: number)
构造函数。
-
参数:
-
**参数:**
| 参数名 | 参数类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------- |
| positionX | number | 是 | 触摸点X坐标。 |
| positionY | number | 是 | 触摸点Y坐标。 |
-
示例
-
**示例:**
```
typescript
let
gesturePoint
=
new
GesturePoint
(
100
,
200
);
...
...
zh-cn/application-dev/reference/apis/js-apis-system-parameter.md
浏览文件 @
d23f2462
...
...
@@ -7,7 +7,7 @@
## 导入模块
```
ts
import
parameter
from
'
@ohos.system
P
arameter
'
import
parameter
from
'
@ohos.system
p
arameter
'
```
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录