IAuxiliaryOptions

​

Interface IAuxiliaryOptions

interface IAuxiliaryOptions

Extends com.amazon.apmf.IStandard The IAuxiliaryOptions interface is used to customize keyboard layouts, such as the keyboard title.

​

Methods

​

getKeyboardTitle()

string getKeyboardTitle()

This method is used to get the title text of on-screen keyboard that got set.

​

Returns

string The text that got set as keyboardTitle. If not set, this method returns an empty string.

---

​

getWidgetStepText()

string getWidgetStepText()

This method is used to get the widget text of on-screen keyboard that got set. This text will be displayed in the title line on the right side.

​

Returns

string The text that got set as widgetStepText. If not set, this method returns an empty string.

---

​

getHintText()

string getHintText()

This method is used to get the hintText, a permanent hint message shown on the footer of InputType::PIN keyboard window.

​

Returns

string The text that got set as hintText. If not set, this method returns an empty string.

---

​

getApplicationMessage()

string getApplicationMessage()

This method is used to get the application message that got set, which will be shown on the footer of the keyboard window (except layouts with dictation hint messages).

​

Returns

string The text that got set as application message. If not set, this method returns an empty string.

---

​

isAdvancedKeyShown()

bool isAdvancedKeyShown()

This method returns true if the “Advanced” key is shown.

​

Returns

bool true, if the “Advanced” key is shown; else false.

---

​

getPreviousKeyLabel()

string getPreviousKeyLabel()

This method gets the label of “Previous” key that got set.

​

Returns

string The label that is replaced with “Previous” key label. If not set, this method returns an empty string.

---

​

getPreviousKeyAction()

com.amazon.kepler.intl.input_method.InputAction? getPreviousKeyAction()

This method is used to get the InputAction flag of “Previous” key that got set.

​

Returns

com.amazon.kepler.intl.input_method.InputAction? The return value is optional and might be absent. Pointer to InputAction flag of “Previous” key that got set. If not set, this method returns NULL.

---

​

getNextKeyLabel()

string getNextKeyLabel()

This method gets the label of “Next” key that got set.

​

Returns

string The label that is replaced with “Next” key label. If not set, this method returns an empty string.

---

​

getNextKeyAction()

com.amazon.kepler.intl.input_method.InputAction? getNextKeyAction()

This method is used to get the InputAction flag of “Next” key that got set.

​

Returns

com.amazon.kepler.intl.input_method.InputAction? The return value is optional and might be absent. Pointer to InputAction flag of “Next” key that got set. If not set, this method returns NULL.

---

​

getAdvancedKeyLabel()

string getAdvancedKeyLabel()

This method gets the label of “Advanced” key that got set.

​

Returns

string The label that is replaced with “Advanced” Key label. If not set, this method returns an empty string.

---

​

getAdvancedKeyAction()

com.amazon.kepler.intl.input_method.InputAction? getAdvancedKeyAction()

This method is used to get the InputAction flag of “Advanced” key that got set.

​

Returns

com.amazon.kepler.intl.input_method.InputAction? The return value is optional and might be absent. Pointer to InputAction flag of “Advanced” key that got set. If not set, this method returns NULL.

---

​

getMinimumInputLength()

u8 getMinimumInputLength()

This method is used to get the minimum input length required to enable the “Next” key.

​

Returns

u8 The input length required to enable the “Next” key. If not set, this method returns 0.

---

​

getMaximumInputLength()

u8 getMaximumInputLength()

This method is used to get the number of digits displayed on InputType::PIN that got set.

​

Returns

u8 The length that represents the number of digits. If not set, this method returns 0.

---

​

getOptionsList()

string[] getOptionsList()

This method is used to get the list of options that will be shown on keyboard layout window. Keyboard will emit the action associated with “Next” key when any option got selected.

​

Returns

string[] The List of options that will be shown on keyboard layout window. If not set, this method returns an empty array.

---

​

getInformationText()

string getInformationText()

This method is used to get the information text that got set. When information text is set, the keyboard window looks as a modal with information text and action keys.

​

Returns

string The text that will be shown as information text. If information text is not set, this method returns an empty string.

---