IAccessibilityService

​

Interface IAccessibilityService

interface IAccessibilityService

Extends com.amazon.apmf.IStandard Centralized interface providing access to accessibility related functionality. See also- IViewModule::makeAccessibilityService.

​

Methods

​

enableEmitChildrenInfo()

void enableEmitChildrenInfo(IView* view)

This method enables the emission of accessibility information for the children of this IView. The child views will get a callback (IAccessibilityDelegate::build) to build their accessibility information.

​

Parameters

view

IView* — Required IView The view for which children accessibility information needs to be emitted.

---

​

disableEmitChildrenInfo()

void disableEmitChildrenInfo(IView* view)

This method disables the emission of accessibility information for the children of this IView. The child views will not get a callback (IAccessibilityDelegate::build) to build their accessibility information.

​

Parameters

view

IView* — Required IView The view for which emission of children accessibility information needs to be disabled.

---

​

invalidate()

void invalidate(IView* view)

This method indicates that this IView’s accessibility properties have changed and requires re-build of its accessibility information.

​

Parameters

view

IView* — Required IView The view which needs to be marked dirty for accessibility information.

---

​

setAsExcluded()

void setAsExcluded(IView* view)

This method marks the IView for not emitting its accessibility information.

​

Parameters

view

IView* — Required IView The view which needs to be excluded from accessibility.

---

​

setAsIncluded()

void setAsIncluded(IView* view)

This method marks the IView for emitting its accessibility information.

​

Parameters

view

IView* — Required IView The view which needs to be excluded from accessibility.

---

​

setDelegate()

void setDelegate(IView* view, IAccessibilityDelegate* accessibilityDelegate)

This method sets the accessibility delegate to the provided view. Setting the delegate will allow the user to get a callback to build and clear the accessibility information.

​

Parameters

view

IView* — Required IView The view for which accessibility information needs to be set.

accessibilityDelegate

IAccessibilityDelegate* — Required IAccessibilityDelegate Instance of the delegate. the consumer.

---