IAuxiliaryOptionsBuilder

​

Interface IAuxiliaryOptionsBuilder

interface IAuxiliaryOptionsBuilder

Extends com.amazon.apmf.IStandard The IAuxiliaryOptionsBuilder interface is used for building an IAuxiliaryOptions object.

​

Methods

​

keyboardTitle()

void keyboardTitle(string title)

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

​

Parameters

title

string — Required The text that should be set as title.

---

​

widgetStepText()

void widgetStepText(string text)

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

​

Parameters

text

string — Required The text that should be set as widgetStepText.

---

​

hintText()

void hintText(string text)

This method is used to set the hintText, a permanent hint message shown on the footer of keyboard window only when InputType::PIN, ignored otherwise.

​

Parameters

text

string — Required The text that should be set as hintText.

---

​

applicationMessage()

void applicationMessage(string message)

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

​

Parameters

message

string — Required The text that should be set as application message.

---

​

advancedKeyShown()

void advancedKeyShown(bool isAdvancedKeyShown)

This method is used to show/hide the “Advanced” key on the action keys row. By default, it is hidden.

​

Parameters

isAdvancedKeyShown

bool — Required If true, shows the “Advanced” key in the keyboard window.

---

​

previousKeyLabel()

void previousKeyLabel(string label)

This method is used to customize the label of “Previous” key.

​

Parameters

label

string — Required The text that will replaced with “Previous” key label.

---

​

previousKeyAction()

void previousKeyAction(com.amazon.kepler.intl.input_method.InputAction inputAction)

This method is used to customize the inputAction flag of “Previous” key.

​

Parameters

inputAction

com.amazon.kepler.intl.input_method.InputAction — Required InputAction InputAction flag of “Previous” key that will be set.

---

​

nextKeyLabel()

void nextKeyLabel(string label)

This method is used to customize the label of “Next” key.

​

Parameters

label

string — Required The text that will replaced with “Next” key label.

---

​

nextKeyAction()

void nextKeyAction(com.amazon.kepler.intl.input_method.InputAction inputAction)

This method is used to customize the inputAction flag of “Next” key.

​

Parameters

inputAction

com.amazon.kepler.intl.input_method.InputAction — Required InputAction InputAction flag of “Next” key that will be set.

---

​

advancedKeyLabel()

void advancedKeyLabel(string label)

This method is used to customize the label of “Advanced” key.

​

Parameters

label

string — Required The text that will replaced with “Advanced” key label.

---

​

advancedKeyAction()

void advancedKeyAction(com.amazon.kepler.intl.input_method.InputAction inputAction)

This method is used to customize the inputAction flag of “Advanced” key.

​

Parameters

inputAction

com.amazon.kepler.intl.input_method.InputAction — Required InputAction InputAction flag of “Advanced” key that will be set.

---

​

minimumInputLength()

void minimumInputLength(u8 length)

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

​

Parameters

length

u8 — Required The input length required to enable the “Next” key.

---

​

maximumInputLength()

void maximumInputLength(u8 length)

This method is used to customize the number of digits displayed on keyboard window only when InputType::PIN, ignored otherwise.

​

Parameters

length

u8 — Required represents the number of digits, which must be within range of {1, 8}. If invalid value set, keyboard is opened with 5 digits.

---

​

optionsList()

void optionsList(string[] optionsList)

Creates a list of clickable options in the keyboard layout window. This method generates a list of clickable items in the keyboard layout window, allowing users to select from a set of provided options. If the optionsList contains elements, the window will display:

• A title
• The clickable list of options
• Action buttons, including a “Next” button

When a user selects one of the options, the keyboard emits an action associated with the “Next” button.

​

Parameters

optionsList

string[] — Required An array of strings, where each string represents an option to be displayed as a clickable item in the keyboard layout window. Note The optionsList must contain at least one option for the list to be displayed. If it’s empty, the keyboard layout window will not show the options. The optionsList represents a series of choices that a user can interact with. These options are rendered as clickable items in the window.

---

​

informationText()

void informationText(string text)

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

​

Parameters

text

string — Required The text that should be shown as information text.

---

​

build()

IAuxiliaryOptions* build()

Builds the IAuxiliaryOptions.

​

Returns

IAuxiliaryOptions* The constructed IAuxiliaryOptions instance.

---