IAction

​

Interface IAction

interface IAction

Extends com.amazon.apmf.IStandard This interface represents a UI action that can be defined by an application or toolkit. UCC clients (assistive technologies or automation tools can request to perform this action)

​

Methods

​

name()

string name()

Get the name of this action The action name is a non localized string that uniquely identifies this action within a particular element. To support standard actions such as “activate”, simply return one of the appropriate standard action name constants above. to define custom actions, use names other than the standard ones.

​

Returns

string the name of this action

---

​

description()

string description()

Get the description of this action This is a localized string that describes this action and will be presented to the user. For example “Delete”, “Cut”, “Paste”, etc.

​

Returns

string the description of this action

---

​

hint()

string hint()

Get the hint for this action The hint describes what will happen when this action is performed, and is typically used by screen readers to help blind customers know how to interact with a component. Action hints are typically composed into usage hint in the form: “%s to %s”%(gesture, hint) where gesture represents a string describing the gesture the screen reader has assigned to the action and hint is the text of the action hint. Generally, your hints should be phrased in active terms “open a book” rather than “opens a book”.

​

Returns

string the hint for this action

---

​

perform()

void perform()

Perform this action

---

​

Constants

​

ACTIVATE

string = "activate"

Standard action to activate this element

​

LONG_PRESS

string = "longPress"

Standard action to long press this element

​

DISMISS

string = "dismiss"

Standard action to dismiss this element