AccessibilitySystemAbilityClient

java.lang.Object
- ohos.accessibility.AccessibilitySystemAbilityClient

```
public class AccessibilitySystemAbilityClient
extends Object
```
Provides a client for interacting with the accessibility ability.
The client provides functions such as sending accessibility events specified by AccessibilityEventInfo to the accessibility ability, querying the accessibility status, and sending accessibility status change notifications.
For example, when a view control gains the focus, this class will send an AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT event to notify the accessibility ability.

从以下版本开始:

1

另请参阅:

AccessibilityEventInfo, AccessibilityStateObserver, AccessibilityAbilityInfo

SystemCapability

SystemCapability.Accessibility#ABILITY

字段概要

字段
限定符和类型	字段	说明
`static int`	`CONTENT_CONTROLS`	Indicates that the control content is a control.
`static int`	`CONTENT_ICONS`	Indicates that the control content is an icon.
`static int`	`CONTENT_TEXT`	Indicates that the control content is text.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`List<AccessibilityAbilityInfo>`	`getAbilityList(int accessibilityAbilityTypes, int stateType)`	Queries the list of accessibility abilities.
`CaptionProperties`	`getAccessibilityCaptionProperties()`	Obtains the properties of the accessibility caption function.
`static AccessibilitySystemAbilityClient`	`getInstance(Context abilityContext)`	Obtains the `AccessibilitySystemAbilityClient` instance.
`int`	`getSuggestedInterval(int timeout, int contentType)`	Obtains the suggested interval for switching the UI.
`boolean`	`isAccessibilityCaptionEnabled()`	Checks whether the accessibility caption function is enabled.
`boolean`	`isEnabled()`	Checks whether accessibility ability is enabled.
`boolean`	`sendEvent(int eventType, int viewId)`	Sends an accessibility event.
`boolean`	`sendEvent(AccessibilityEventInfo eventInfo)`	Sends information about an accessibility event.
`boolean`	`subscribeStateObserver(AccessibilityStateObserver observer, int eventType)`	Subscribes to the specified type of accessibility status change events.
`boolean`	`unsubscribeStateObserver(AccessibilityStateObserver observer)`	Unsubscribe the accessibility status change events from the observer.
`boolean`	`unSubscribeStateObserver(AccessibilityStateObserver observer, int eventType)`	Unsubscribe the specified type of accessibility status change events.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CONTENT_CONTROLS
```
public static final int CONTENT_CONTROLS
```
    Indicates that the control content is a control.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    常量字段值
  - CONTENT_ICONS
```
public static final int CONTENT_ICONS
```
    Indicates that the control content is an icon.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    常量字段值
  - CONTENT_TEXT
```
public static final int CONTENT_TEXT
```
    Indicates that the control content is text.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static AccessibilitySystemAbilityClient getInstance(Context abilityContext)
```
    Obtains the AccessibilitySystemAbilityClient instance.
    
    参数:
    
    abilityContext - Indicates the context of the associated ability.
    
    返回:
    
    Returns the client instance.
  - sendEvent
```
public boolean sendEvent(int eventType,
                         int viewId)
```
    Sends an accessibility event.
    This method is used to send an accessibility event to the accessibility ability.
    For example, when a view control gains the focus, this method will send an AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT event to notify the accessibility ability.
    
    参数:
    
    eventType - Identifies the accessibility event specified by AccessibilityEventInfo.
    
    viewId - Indicates the ID of the view to be associated with the event.
    
    返回:
    
    Returns True if the event is successfully sent; returns False otherwise, for example, the event ID is invalid or the accessibility ability is disabled.
  - sendEvent
```
public boolean sendEvent(AccessibilityEventInfo eventInfo)
```
    Sends information about an accessibility event.
    This method is used to send information about an accessibility event to the accessibility ability.
    For example, when a view control gains the focus, your app can use this method to send information about an AccessibilityEventInfo#TYPE_VIEW_FOCUSED_EVENT event to notify the accessibility ability, such as the action triggering this event, package name of the target application, associated view ID, and event record list.
    
    参数:
    
    eventInfo - Indicates the accessibility event information specified by AccessibilityEventInfo.
    
    返回:
    
    Returns True if the event information is successfully sent; returns False if the event information fails to be sent for reasons such as the event ID is invalid or the accessibility ability is disabled.
    
    从以下版本开始:
    
    2
  - getAbilityList
```
public List<AccessibilityAbilityInfo> getAbilityList(int accessibilityAbilityTypes,
                                                     int stateType)
```
    Queries the list of accessibility abilities.
    This method is used to query information about specified accessibility abilities with the given search criteria. For example, you can use this method to check whether an ability is enabled and send a notification to the application if no match is found.
    
    参数:
    
    accessibilityAbilityTypes - Indicates the accessibility type specified by AccessibilityAbilityInfo#ACCESSIBILITY_ABILITY_TYPE_SPOKEN.
    
    stateType - Indicates the accessibility ability status. 1 indicates that the ability is enabled; 2 indicates that the ability is disabled; 3 indicates that the ability has been installed.
    
    返回:
    
    Returns the list of accessibility abilities that meet the search criteria.
    
    另请参阅:
    
    AccessibilityAbilityInfo
  - isEnabled
```
public boolean isEnabled()
```
    Checks whether accessibility ability is enabled.
    
    返回:
    
    Returns True if accessibility ability is enabled; returns False otherwise.
  - subscribeStateObserver
```
public boolean subscribeStateObserver(AccessibilityStateObserver observer,
                                      int eventType)
```
    Subscribes to the specified type of accessibility status change events.
    This method will receive a notification when the accessibility status has changed, for example, the accessibility ability is unavailable.
    
    参数:
    
    observer - Indicates the observer for listening to status events, which is specified by AccessibilityStateObserver.
    
    eventType - Indicates the status type, which is specified by AccessibilityStateEvent#EVENT_ACCESSIBILITY_STATE_CHANGED and AccessibilityStateEvent#EVENT_TOUCH_BROWSE_STATE_CHANGED.
    
    返回:
    
    Returns True if the subscription is successful; returns False if an invalid parameter exists or the accessibility ability is disabled.
    
    另请参阅:
    
    AccessibilityStateObserver
  - unSubscribeStateObserver
```
public boolean unSubscribeStateObserver(AccessibilityStateObserver observer,
                                        int eventType)
```
    Unsubscribe the specified type of accessibility status change events.
    
    参数:
    
    observer - Indicates the registered accessibility status event observer.
    
    eventType - Indicates the status type, which is specified by AccessibilityStateEvent#EVENT_ACCESSIBILITY_STATE_CHANGED and AccessibilityStateEvent#EVENT_TOUCH_BROWSE_STATE_CHANGED.
    
    返回:
    
    Returns True if the unsubscription is successful; returns False if an invalid parameter exists or the accessibility ability is disabled.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    AccessibilityStateObserver
  - unsubscribeStateObserver
```
public boolean unsubscribeStateObserver(AccessibilityStateObserver observer)
```
    Unsubscribe the accessibility status change events from the observer.
    
    参数:
    
    observer - Indicates the registered accessibility status event observer.
    
    返回:
    
    Returns True if the unsubscription is successful; returns False if an invalid parameter exists or the accessibility ability is disabled.
    
    另请参阅:
    
    AccessibilityStateObserver
  - isAccessibilityCaptionEnabled
```
public boolean isAccessibilityCaptionEnabled()
```
    Checks whether the accessibility caption function is enabled.
    
    返回:
    
    Returns True if the caption function is enabled; returns False otherwise.
    
    从以下版本开始:
    
    2
  - getAccessibilityCaptionProperties
```
public CaptionProperties getAccessibilityCaptionProperties()
```
    Obtains the properties of the accessibility caption function.
    
    返回:
    
    Returns the properties of the accessibility caption function.
    
    从以下版本开始:
    
    2
  - getSuggestedInterval
```
public int getSuggestedInterval(int timeout,
                                int contentType)
```
    Obtains the suggested interval for switching the UI.
    
    参数:
    
    timeout - Indicates the interval at which the UI is changed.
    
    contentType - Indicates the type of the UI control.
    
    返回:
    
    Returns the interval.
    
    从以下版本开始:
    
    4

类 AccessibilitySystemAbilityClient

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CONTENT_CONTROLS

CONTENT_ICONS

CONTENT_TEXT

方法详细资料

getInstance

sendEvent

sendEvent

getAbilityList

isEnabled

subscribeStateObserver

unSubscribeStateObserver

unsubscribeStateObserver

isAccessibilityCaptionEnabled

getAccessibilityCaptionProperties

getSuggestedInterval