com.smartdevicelink.managers.screen.choiceset

Class ChoiceSet

java.lang.Object

com.smartdevicelink.managers.screen.choiceset.ChoiceSet

public class ChoiceSet
extends Object

Constructor Summary

Constructors

Constructor and Description
ChoiceSet(String title, ChoiceSetLayout layout, Integer timeout, List<TTSChunk> initialPrompt, List<TTSChunk> timeoutPrompt, List<TTSChunk> helpPrompt, List<VrHelpItem> helpList, KeyboardProperties customKeyboardConfiguration, List<ChoiceCell> choices, ChoiceSetSelectionListener listener) Constructor with all possible properties.
ChoiceSet(String title, ChoiceSetLayout layout, Integer timeout, String initialPrompt, String timeoutPrompt, String helpPrompt, List<VrHelpItem> helpList, KeyboardProperties customKeyboardConfiguration, List<ChoiceCell> choices, ChoiceSetSelectionListener listener) Constructor with all possible properties.
ChoiceSet(String title, List<ChoiceCell> choices, ChoiceSetSelectionListener listener) Initialize with a title, listener, and choices.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the choice set.
List<ChoiceCell>	getChoices() The choices to be displayed to the user within this choice set.
ChoiceSetSelectionListener	getChoiceSetSelectionListener() The listener of this choice set, called when the user interacts with it.
KeyboardProperties	getCustomKeyboardConfiguration() Implement this in order to provide a custom keyboard configuration to just this keyboard.
int	getDefaultTimeout()
List<TTSChunk>	getHelpPrompt() Maps to PerformInteraction.helpPrompt.
List<TTSChunk>	getInitialPrompt() Maps to PerformInteraction.initialPrompt.
ChoiceSetLayout	getLayout() Maps to PerformInteraction.interactionLayout.
Integer	getTimeout() Maps to PerformInteraction.timeout.
List<TTSChunk>	getTimeoutPrompt() Maps to PerformInteraction.timeoutPrompt.
String	getTitle() Maps to PerformInteraction.initialText.
List<VrHelpItem>	getVrHelpList() Maps to PerformInteraction.vrHelp.
void	setChoices(List<ChoiceCell> choices)
void	setChoiceSetSelectionListener(ChoiceSetSelectionListener choiceSetSelectionListener)
void	setCustomKeyboardConfiguration(KeyboardProperties customKeyboardConfiguration) Implement this in order to provide a custom keyboard configuration to just this keyboard.
void	setDefaultTimeout(int defaultTimeout) Set this to change the default timeout for all ChoiceSets.
void	setHelpPrompt(List<TTSChunk> helpPrompt)
void	setInitialPrompt(List<TTSChunk> initialPrompt)
void	setLayout(ChoiceSetLayout layout)
void	setTimeout(Integer timeout) Maps to PerformInteraction.timeout.
void	setTimeoutPrompt(List<TTSChunk> timeoutPrompt)
void	setTitle(String title)
void	setVrHelpList(List<VrHelpItem> vrHelpList)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChoiceSet

public ChoiceSet(@NonNull
                 String title,
                 @NonNull
                 List<ChoiceCell> choices,
                 @NonNull
                 ChoiceSetSelectionListener listener)

Initialize with a title, listener, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be `null`. NOTE: If you display multiple cells with the same `text` with the only uniquing property between cells being different `vrCommands` or a feature that is not displayed on the head unit (e.g. if the head unit doesn't display `secondaryArtwork` and that's the only uniquing property between two cells) then the cells may appear to be the same to the user in `Manual` mode. This only applies to RPC connections >= 7.1.0. NOTE: On < 7.1.0 connections, the `text` cell will be automatically modified among cells that have the same `text` when they are preloaded, so they will always appear differently on-screen when they are displayed. `choiceCell.uniqueText` will be created by appending ` (2)`, ` (3)`, etc.

Parameters:

title - - The choice set's title

listener - - The choice set listener called after the user has interacted with your choice set

choices - - The choices to be displayed to the user for interaction

ChoiceSet

public ChoiceSet(@NonNull
                 String title,
                 @Nullable
                 ChoiceSetLayout layout,
                 @Nullable
                 Integer timeout,
                 @Nullable
                 String initialPrompt,
                 @Nullable
                 String timeoutPrompt,
                 @Nullable
                 String helpPrompt,
                 @Nullable
                 List<VrHelpItem> helpList,
                 @Nullable
                 KeyboardProperties customKeyboardConfiguration,
                 @NonNull
                 List<ChoiceCell> choices,
                 @NonNull
                 ChoiceSetSelectionListener listener)

Constructor with all possible properties. NOTE: If you display multiple cells with the same `text` with the only uniquing property between cells being different `vrCommands` or a feature that is not displayed on the head unit (e.g. if the head unit doesn't display `secondaryArtwork` and that's the only uniquing property between two cells) then the cells may appear to be the same to the user in `Manual` mode. This only applies to RPC connections >= 7.1.0. NOTE: On < 7.1.0 connections, the `text` cell will be automatically modified among cells that have the same `text` when they are preloaded, so they will always appear differently on-screen when they are displayed. `choiceCell.uniqueText` will be created by appending ` (2)`, ` (3)`, etc.

Parameters:

title - - The choice set's title

listener - - The choice set listener called after the user has interacted with your choice set

layout - - The layout of choice options (Manual/touch only)

timeout - - The timeout of a touch interaction (Manual/touch only). This is set to seconds if using the screen manager.

initialPrompt - - A voice prompt spoken to the user when this set is displayed

timeoutPrompt - - A voice prompt spoken to the user when the set times out (Voice only)

helpPrompt - - A voice prompt spoken to the user when the user asks for "help"

helpList - - A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only)

choices - - The list of choices presented to the user either as a manual/touch interaction or via the user's voice

customKeyboardConfiguration - - Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see ScreenManager.setKeyboardConfiguration

ChoiceSet

public ChoiceSet(@NonNull
                 String title,
                 @Nullable
                 ChoiceSetLayout layout,
                 @Nullable
                 Integer timeout,
                 @Nullable
                 List<TTSChunk> initialPrompt,
                 @Nullable
                 List<TTSChunk> timeoutPrompt,
                 @Nullable
                 List<TTSChunk> helpPrompt,
                 @Nullable
                 List<VrHelpItem> helpList,
                 @Nullable
                 KeyboardProperties customKeyboardConfiguration,
                 @NonNull
                 List<ChoiceCell> choices,
                 @NonNull
                 ChoiceSetSelectionListener listener)

Constructor with all possible properties. NOTE: If you display multiple cells with the same `text` with the only uniquing property between cells being different `vrCommands` or a feature that is not displayed on the head unit (e.g. if the head unit doesn't display `secondaryArtwork` and that's the only uniquing property between two cells) then the cells may appear to be the same to the user in `Manual` mode. This only applies to RPC connections >= 7.1.0. NOTE: On < 7.1.0 connections, the `text` cell will be automatically modified among cells that have the same `text` when they are preloaded, so they will always appear differently on-screen when they are displayed. `choiceCell.uniqueText` will be created by appending ` (2)`, ` (3)`, etc.

Parameters:

title - - The choice set's title

listener - - The choice set listener called after the user has interacted with your choice set

layout - - The layout of choice options (Manual/touch only)

timeout - - The timeout of a touch interaction (Manual/touch only). This is set to seconds if using the screen manager.

initialPrompt - - A voice prompt spoken to the user when this set is displayed

timeoutPrompt - - A voice prompt spoken to the user when the set times out (Voice only)

helpPrompt - - A voice prompt spoken to the user when the user asks for "help"

helpList - - A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only)

choices - - The list of choices presented to the user either as a manual/touch interaction or via the user's voice

customKeyboardConfiguration - - Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see ScreenManager.setKeyboardConfiguration

Method Detail

cancel

public void cancel()

Cancels the choice set. If the choice set has not yet been sent to Core, it will not be sent. If the choice set is already presented on Core, the choice set will be immediately dismissed. Canceling an already presented choice set will only work if connected to Core versions 6.0+. On older versions of Core, the choice set will not be dismissed.

getTitle

public String getTitle()

Maps to PerformInteraction.initialText. The title of the choice set, and/or the initial text on a keyboard prompt.

Returns:

the title

setTitle

public void setTitle(String title)

Parameters:

title - - Maps to PerformInteraction.initialText. The title of the choice set, and/or the initial text on a keyboard prompt.

getInitialPrompt

public List<TTSChunk> getInitialPrompt()

Maps to PerformInteraction.initialPrompt. The initial prompt spoken to the user at the start of an interaction.

Returns:

The list of TTSChunks

setInitialPrompt

public void setInitialPrompt(List<TTSChunk> initialPrompt)

Parameters:

initialPrompt - - Maps to PerformInteraction.initialPrompt. The initial prompt spoken to the user at the start of an interaction.

getTimeoutPrompt

public List<TTSChunk> getTimeoutPrompt()

Maps to PerformInteraction.timeoutPrompt. This text is spoken when a VR interaction times out. If this set is presented in a manual (non-voice) only interaction, this will be ignored.

Returns:

- The list of TTS Chunks

setTimeoutPrompt

public void setTimeoutPrompt(List<TTSChunk> timeoutPrompt)

Parameters:

timeoutPrompt - - Maps to PerformInteraction.timeoutPrompt. This text is spoken when a VR interaction times out. If this set is presented in a manual (non-voice) only interaction, this will be ignored.

getHelpPrompt

public List<TTSChunk> getHelpPrompt()

Maps to PerformInteraction.helpPrompt. This is the spoken string when a user speaks "help" when the interaction is occurring.

Returns:

The List of TTS Chunks

setHelpPrompt

public void setHelpPrompt(List<TTSChunk> helpPrompt)

Parameters:

helpPrompt - - Maps to PerformInteraction.helpPrompt. This is the spoken string when a user speaks "help" when the interaction is occurring.

getVrHelpList

public List<VrHelpItem> getVrHelpList()

Maps to PerformInteraction.vrHelp. This is a list of help text presented to the user when they are in a voice recognition interaction from your choice set of options. If this set is presented in a touch only interaction, this will be ignored.

Note: That while VRHelpItem's position will be automatically set based on position in the array, the image will need to uploaded by you before use using the FileManager.

Returns:

The List of VR Help Items

setVrHelpList

public void setVrHelpList(List<VrHelpItem> vrHelpList)

Parameters:

vrHelpList - - Maps to PerformInteraction.vrHelp. This is a list of help text presented to the user when they are in a voice recognition interaction from your choice set of options. If this set is presented in a touch only interaction, this will be ignored.

Note: That while SDLVRHelpItem's position will be automatically set based on position in the array, the image will need to uploaded by you before use using the FileManager.

getLayout

public ChoiceSetLayout getLayout()

Maps to PerformInteraction.interactionLayout. Whether the presented choices are arranged as a set of tiles or a list.

Returns:

The ChoiceSetLayout

setLayout

public void setLayout(ChoiceSetLayout layout)

Parameters:

layout - - Maps to PerformInteraction.interactionLayout. Whether the presented choices are arranged as a set of tiles or a list.

getTimeout

public Integer getTimeout()

Maps to PerformInteraction.timeout. This applies only to a manual selection (not a voice selection, which has its timeout handled by the system). Defaults to `defaultTimeout`.

Returns:

The Timeout

setTimeout

public void setTimeout(Integer timeout)

Maps to PerformInteraction.timeout. Timeout in seconds. Defaults to 0, which will use `defaultTimeout`. If this is set below the minimum, it will be capped at 5 seconds. Minimum 5 seconds, maximum 100 seconds. If this is set above the maximum, it will be capped at 100 seconds.

getDefaultTimeout

public int getDefaultTimeout()

setDefaultTimeout

public void setDefaultTimeout(int defaultTimeout)

Set this to change the default timeout for all ChoiceSets. If a timeout is not set on an individual ChoiceSet object (or if it is set to 0), then it will use this timeout instead. See `timeout` for more details. If this is not set by you, it will default to 10 seconds. The minimum is 5 seconds, the maximum is 100 seconds. If this is set below the minimum, it will be capped at 3 seconds. If this is set above the maximum, it will be capped at 10 seconds.

getChoices

public List<ChoiceCell> getChoices()

The choices to be displayed to the user within this choice set. These choices could match those already preloaded

This is limited to 100 items. If you attempt to set more than 100 items, the set will not have any items (this array will be empty).

Returns:

The List of ChoiceCells

setChoices

public void setChoices(List<ChoiceCell> choices)

Parameters:

choices - - The choices to be displayed to the user within this choice set. These choices could match those already preloaded

This is limited to 100 items. If you attempt to set more than 100 items, the set will not have any items (this array will be empty).

getChoiceSetSelectionListener

public ChoiceSetSelectionListener getChoiceSetSelectionListener()

The listener of this choice set, called when the user interacts with it.

Returns:

The listener

setChoiceSetSelectionListener

public void setChoiceSetSelectionListener(ChoiceSetSelectionListener choiceSetSelectionListener)

Parameters:

choiceSetSelectionListener - The listener of this choice set, called when the user interacts with it.

setCustomKeyboardConfiguration

public void setCustomKeyboardConfiguration(KeyboardProperties customKeyboardConfiguration)

Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see ScreenManager.setKeyboardConfiguration

Parameters:

customKeyboardConfiguration - - the keyboard config used for this choice set

getCustomKeyboardConfiguration

public KeyboardProperties getCustomKeyboardConfiguration()

Implement this in order to provide a custom keyboard configuration to just this keyboard. To apply default settings to all keyboards, see ScreenManager.setKeyboardConfiguration

Returns:

the custom keyboard configuration