鸿蒙OS AccessibilitySystemAbilityClient

AccessibilitySystemAbilityClient

java.lang.Object

|—ohos.accessibility.AccessibilitySystemAbilityClient

public class AccessibilitySystemAbilityClient
extends Object

提供与可访问性功能交互的客户端。

客户端提供向无障碍能力发送AccessibilityEventInfo指定的无障碍事件、查询无障碍状态、发送无障碍状态变化通知等功能。

例如，当视图控件获得焦点时，该类将发送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件来通知可访问性。

字段摘要

方法总结

字段详细信息

CONTENT_CONTROLS

public static final int CONTENT_CONTROLS

表示控件内容为控件。

CONTENT_ICONS

public static final int CONTENT_ICONS

表示控件内容为图标。

CONTENT_TEXT

public static final int CONTENT_TEXT

表示控件内容为文本。

方法详情

getInstance

public static AccessibilitySystemAbilityClient getInstance(Context abilityContext)

获取 AccessibilitySystemAbilityClient 实例。

参数：

返回:

返回客户端实例。

sendEvent

public boolean sendEvent(int eventType, int viewId)

发送可访问性事件。

此方法用于向可访问性能力发送可访问性事件。

例如，当视图控件获得焦点时，此方法将发送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件以通知可访问性。

参数：

返回:

如果事件发送成功，则返回 True； 否则返回 False，例如，事件 ID 无效或可访问性被禁用。

sendEvent

public boolean sendEvent(AccessibilityEventInfo eventInfo)

发送有关可访问性事件的信息。

此方法用于将有关可访问性事件的信息发送到可访问性功能。

例如，当视图控件获得焦点时，您的应用可以使用此方法发送有关 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件的信息，以通知可访问性，例如触发此事件的操作、目标应用程序的包名称、关联的视图 ID , 和事件记录列表。

参数：

返回:

如果事件信息发送成功，则返回 True； 如果由于事件 ID 无效或无障碍功能被禁用等原因导致事件信息发送失败，则返回 False。

getAbilityList

public ListAccessibilityAbilityInfo getAbilityList(int accessibilityAbilityTypes, int stateType)

查询辅助功能列表。

此方法用于使用给定的搜索条件查询有关指定辅助功能的信息。 例如，您可以使用此方法检查是否启用了某个功能，如果未找到匹配项，则向应用程序发送通知。

参数：

返回:

返回满足搜索条件的辅助功能列表。

isEnabled

public boolean isEnabled()

检查是否启用了辅助功能。

返回:

如果启用了可访问性功能，则返回 True； 否则返回 False。

subscribeStateObserver

public boolean subscribeStateObserver(AccessibilityStateObserver observer, int eventType)

订阅指定类型的可访问性状态更改事件。

当可访问性状态发生变化时，该方法会收到通知，例如可访问性不可用。

参数：

返回:

订阅成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。

unSubscribeStateObserver

public boolean unSubscribeStateObserver(AccessibilityStateObserver observer, int eventType)

取消订阅指定类型的可访问性状态更改事件。

参数：

返回:

退订成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。

unsubscribeStateObserver

public boolean unsubscribeStateObserver(AccessibilityStateObserver observer)

取消订阅观察者的可访问性状态更改事件。

参数：

返回:

退订成功返回True； 如果存在无效参数或禁用可访问性功能，则返回 False。

isAccessibilityCaptionEnabled

public boolean isAccessibilityCaptionEnabled()

检查无障碍字幕功能是否开启。

返回:

如果启用了字幕功能，则返回 True； 否则返回 False。

getAccessibilityCaptionProperties

public CaptionProperties getAccessibilityCaptionProperties()

获取无障碍字幕函数的属性。

返回:

返回辅助功能标题函数的属性。

getSuggestedInterval

public int getSuggestedInterval(int timeout, int contentType)

获取切换UI的建议间隔。

参数：

返回:

返回间隔。