java.lang.Object
|---ohos.accessibility.AccessibilitySystemAbilityClient
public class AccessibilitySystemAbilityClient
extends Object
提供与可访问性功能交互的客户端。
客户端提供向无障碍能力发送AccessibilityEventInfo指定的无障碍事件、查询无障碍状态、发送无障碍状态变化通知等功能。
例如，当视图控件获得焦点时，该类将发送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件来通知可访问性。
| 修饰符和类型 | 字段 | 描述 |
|---|---|---|
| static int | CONTENT_CONTROLS | 表示控件内容为控件。 |
| static int | CONTENT_ICONS | 表示控件内容为图标。 |
| static int | CONTENT_TEXT | 表示控件内容为文本。 |
| 修饰符和类型 | 方法 | 描述 |
|---|---|---|
| ListAccessibilityAbilityInfo | getAbilityList(int accessibilityAbilityTypes, int stateType) | 查询辅助功能列表。 |
| CaptionProperties | getAccessibilityCaptionProperties() | 获取无障碍字幕函数的属性。 |
| static AccessibilitySystemAbilityClient | getInstance(Context abilityContext) | 获取 AccessibilitySystemAbilityClient 实例。 |
| int | getSuggestedInterval(int timeout, int contentType) | 获取切换UI的建议间隔。 |
| boolean | isAccessibilityCaptionEnabled() | 检查无障碍字幕功能是否开启。 |
| boolean | isEnabled() | 检查是否启用了辅助功能。 |
| boolean | sendEvent(int eventType, int viewId) | 发送可访问性事件。 |
| boolean | sendEvent(AccessibilityEventInfo eventInfo) | 发送有关可访问性事件的信息。 |
| boolean | subscribeStateObserver(AccessibilityStateObserver observer, int eventType) | 订阅指定类型的可访问性状态更改事件。 |
| boolean | unsubscribeStateObserver(AccessibilityStateObserver observer) | 取消订阅观察者的可访问性状态更改事件。 |
| boolean | unSubscribeStateObserver(AccessibilityStateObserver observer, int eventType) | 取消订阅指定类型的可访问性状态更改事件。 |
| 从类 java.lang.Object 继承的方法 |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public static final int CONTENT_CONTROLS
表示控件内容为控件。
public static final int CONTENT_ICONS
表示控件内容为图标。
public static final int CONTENT_TEXT
表示控件内容为文本。
public static AccessibilitySystemAbilityClient getInstance(Context abilityContext)
获取 AccessibilitySystemAbilityClient 实例。
参数：
| 参数名称 | 参数描述 |
|---|---|
| abilityContext | 指示相关能力的上下文。 |
返回:
返回客户端实例。
public boolean sendEvent(int eventType, int viewId)
发送可访问性事件。
此方法用于向可访问性能力发送可访问性事件。
例如，当视图控件获得焦点时，此方法将发送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件以通知可访问性。
参数：
| 参数名称 | 参数描述 |
|---|---|
| eventType | 标识由 AccessibilityEventInfo 指定的可访问性事件。 |
| viewId | 指示要与事件关联的视图的 ID。 |
返回:
如果事件发送成功，则返回 True； 否则返回 False，例如，事件 ID 无效或可访问性被禁用。
public boolean sendEvent(AccessibilityEventInfo eventInfo)
发送有关可访问性事件的信息。
此方法用于将有关可访问性事件的信息发送到可访问性功能。
例如，当视图控件获得焦点时，您的应用可以使用此方法发送有关 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件的信息，以通知可访问性，例如触发此事件的操作、目标应用程序的包名称、关联的视图 ID , 和事件记录列表。
参数：
| 参数名称 | 参数描述 |
|---|---|
| eventInfo | 指示由 AccessibilityEventInfo 指定的可访问性事件信息。 |
返回:
如果事件信息发送成功，则返回 True； 如果由于事件 ID 无效或无障碍功能被禁用等原因导致事件信息发送失败，则返回 False。
public ListAccessibilityAbilityInfo getAbilityList(int accessibilityAbilityTypes, int stateType)
查询辅助功能列表。
此方法用于使用给定的搜索条件查询有关指定辅助功能的信息。 例如，您可以使用此方法检查是否启用了某个功能，如果未找到匹配项，则向应用程序发送通知。
参数：
| 参数名称 | 参数描述 |
|---|---|
| accessibilityAbilityTypes | 指示由 AccessibilityAbilityInfo#ACCESSIBILITY_ABILITY_TYPE_SPOKEN 指定的可访问性类型。 |
| stateType | 指示可访问性能力状态。 1 表示启用该能力； 2 表示能力被禁用； 3 表示已安装该能力。 |
返回:
返回满足搜索条件的辅助功能列表。
public boolean isEnabled()
检查是否启用了辅助功能。
返回:
如果启用了可访问性功能，则返回 True； 否则返回 False。
public boolean subscribeStateObserver(AccessibilityStateObserver observer, int eventType)
订阅指定类型的可访问性状态更改事件。
当可访问性状态发生变化时，该方法会收到通知，例如可访问性不可用。
参数：
| 参数名称 | 参数描述 |
|---|---|
| observer | 表示监听状态事件的观察者，由 AccessibilityStateObserver 指定。 |
| eventType | 指示状态类型，由 AccessibilityStateEvent#EVENT_ACCESSIBILITY_STATE_CHANGED 和 AccessibilityStateEvent#EVENT_TOUCH_BROWSE_STATE_CHANGED 指定。 |
返回:
订阅成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。
public boolean unSubscribeStateObserver(AccessibilityStateObserver observer, int eventType)
取消订阅指定类型的可访问性状态更改事件。
参数：
| 参数名称 | 参数描述 |
|---|---|
| observer | 表示注册的可访问性状态事件观察者。 |
| eventType | 指示状态类型，由 AccessibilityStateEvent#EVENT_ACCESSIBILITY_STATE_CHANGED 和 AccessibilityStateEvent#EVENT_TOUCH_BROWSE_STATE_CHANGED 指定。 |
返回:
退订成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。
public boolean unsubscribeStateObserver(AccessibilityStateObserver observer)
取消订阅观察者的可访问性状态更改事件。
参数：
| 参数名称 | 参数描述 |
|---|---|
| observer | 表示注册的可访问性状态事件观察者。 |
返回:
退订成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。
public boolean isAccessibilityCaptionEnabled()
检查无障碍字幕功能是否开启。
返回:
如果启用了字幕功能，则返回 True； 否则返回 False。
public CaptionProperties getAccessibilityCaptionProperties()
获取无障碍字幕函数的属性。
返回:
返回辅助功能标题函数的属性。
public int getSuggestedInterval(int timeout, int contentType)
获取切换UI的建议间隔。
参数：
| 参数名称 | 参数描述 |
|---|---|
| timeout | 指示 UI 更改的时间间隔。 |
| contentType | 指示 UI 控件的类型。 |
返回:
返回间隔。
备案信息： 粤ICP备15087711号-2
Copyright © 2008-2024 啊嘎哇在线工具箱 All Rights.
本站所有资料来源于网络，版权归原作者所有，仅作学习交流使用，如不慎侵犯了您的权利，请联系我们。