鴻蒙OS AccessibilitySystemAbilityClient

AccessibilitySystemAbilityClient

java.lang.Object

|---ohos.accessibility.AccessibilitySystemAbilityClient

public class AccessibilitySystemAbilityClient
extends Object

提供與可訪問(wèn)性功能交互的客戶端。

客戶端提供向無(wú)障礙能力發(fā)送AccessibilityEventInfo指定的無(wú)障礙事件、查詢無(wú)障礙狀態(tài)、發(fā)送無(wú)障礙狀態(tài)變化通知等功能。

例如，當(dāng)視圖控件獲得焦點(diǎn)時(shí)，該類將發(fā)送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件來(lái)通知可訪問(wèn)性。

字段摘要

方法總結(jié)

字段詳細(xì)信息

CONTENT_CONTROLS

public static final int CONTENT_CONTROLS

表示控件內(nèi)容為控件。

CONTENT_ICONS

public static final int CONTENT_ICONS

表示控件內(nèi)容為圖標(biāo)。

CONTENT_TEXT

public static final int CONTENT_TEXT

表示控件內(nèi)容為文本。

方法詳情

getInstance

public static AccessibilitySystemAbilityClient getInstance(Context abilityContext)

獲取 AccessibilitySystemAbilityClient 實(shí)例。

參數(shù)：

返回:

返回客戶端實(shí)例。

sendEvent

public boolean sendEvent(int eventType, int viewId)

發(fā)送可訪問(wèn)性事件。

此方法用于向可訪問(wèn)性能力發(fā)送可訪問(wèn)性事件。

例如，當(dāng)視圖控件獲得焦點(diǎn)時(shí)，此方法將發(fā)送 AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件以通知可訪問(wèn)性。

參數(shù)：

返回:

如果事件發(fā)送成功，則返回 True； 否則返回 False，例如，事件 ID 無(wú)效或可訪問(wèn)性被禁用。

sendEvent

public boolean sendEvent(AccessibilityEventInfo eventInfo)

發(fā)送有關(guān)可訪問(wèn)性事件的信息。

此方法用于將有關(guān)可訪問(wèn)性事件的信息發(fā)送到可訪問(wèn)性功能。

例如，當(dāng)視圖控件獲得焦點(diǎn)時(shí)，您的應(yīng)用可以使用此方法發(fā)送有關(guān) AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT 事件的信息，以通知可訪問(wèn)性，例如觸發(fā)此事件的操作、目標(biāo)應(yīng)用程序的包名稱、關(guān)聯(lián)的視圖 ID , 和事件記錄列表。

參數(shù)：

返回:

如果事件信息發(fā)送成功，則返回 True； 如果由于事件 ID 無(wú)效或無(wú)障礙功能被禁用等原因?qū)е率录畔l(fā)送失敗，則返回 False。

getAbilityList

public ListAccessibilityAbilityInfo getAbilityList(int accessibilityAbilityTypes, int stateType)

查詢輔助功能列表。

此方法用于使用給定的搜索條件查詢有關(guān)指定輔助功能的信息。 例如，您可以使用此方法檢查是否啟用了某個(gè)功能，如果未找到匹配項(xiàng)，則向應(yīng)用程序發(fā)送通知。

參數(shù)：

返回:

返回滿足搜索條件的輔助功能列表。

isEnabled

public boolean isEnabled()

檢查是否啟用了輔助功能。

返回:

如果啟用了可訪問(wèn)性功能，則返回 True； 否則返回 False。

subscribeStateObserver

public boolean subscribeStateObserver(AccessibilityStateObserver observer, int eventType)

訂閱指定類型的可訪問(wèn)性狀態(tài)更改事件。

當(dāng)可訪問(wèn)性狀態(tài)發(fā)生變化時(shí)，該方法會(huì)收到通知，例如可訪問(wèn)性不可用。

參數(shù)：

返回:

訂閱成功返回True； 如果存在無(wú)效參數(shù)或禁用可訪問(wèn)性功能，則返回 False。

unSubscribeStateObserver

public boolean unSubscribeStateObserver(AccessibilityStateObserver observer, int eventType)

取消訂閱指定類型的可訪問(wèn)性狀態(tài)更改事件。

參數(shù)：

返回:

退訂成功返回True； 如果存在無(wú)效參數(shù)或禁用可訪問(wèn)性功能，則返回 False。

unsubscribeStateObserver

public boolean unsubscribeStateObserver(AccessibilityStateObserver observer)

取消訂閱觀察者的可訪問(wèn)性狀態(tài)更改事件。

參數(shù)：

返回:

退訂成功返回True； 如果存在無(wú)效參數(shù)或禁用可訪問(wèn)性功能，則返回 False。

isAccessibilityCaptionEnabled

public boolean isAccessibilityCaptionEnabled()

檢查無(wú)障礙字幕功能是否開(kāi)啟。

返回:

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

getAccessibilityCaptionProperties

public CaptionProperties getAccessibilityCaptionProperties()

獲取無(wú)障礙字幕函數(shù)的屬性。

返回:

返回輔助功能標(biāo)題函數(shù)的屬性。

getSuggestedInterval

public int getSuggestedInterval(int timeout, int contentType)

獲取切換UI的建議間隔。

參數(shù)：

返回:

返回間隔。