PerformInteraction (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.PerformInteraction

All Implemented Interfaces:: Cloneable

public class PerformInteraction
extends RPCRequest

Performs an application-initiated interaction in which the user can select a Choice from among the specified Choice Sets. For instance, an application may use a PerformInteraction to ask a user to say the name of a song to play. The user's response is only valid if it appears in the specified Choice Sets and is recognized by SDL

If connecting to SDL Core v.6.0+, the perform interaction can be canceled programmatically using the `cancelID`. On older versions of SDL Core, the perform interaction will persist until the user has interacted with the perform interaction or the specified timeout has elapsed.

Function Group: Base

HMILevel needs to be FULL

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
initialText	String	Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated	Y	maxlength:500	SmartDeviceLink 1.0
initialPrompt	TTSChunk	An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction.	Y	minsize:1; maxsize:100	SmartDeviceLink 1.0
interactionMode	InteractionMode	Indicates how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH).	Y		SmartDeviceLink 1.0
interactionChoiceSetIDList	Integer	Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets.	Y	minsize:0; maxsize:100; minvalue:0; maxvalue:2000000000	SmartDeviceLink 1.0
helpPrompt	TTSChunk	An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session. If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter.	N	minsize:1; maxsize:100; The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction.	SmartDeviceLink 1.0
timeoutPrompt	TTSChunk	An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session. If this parameter is omitted, the timeout prompt will be the same as the help prompt (see helpPrompt parameter).	N	The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction. minsize:1;maxsize:100	SmartDeviceLink 1.0
timeout	Integer	The amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms.	N	minvalue:5000; maxvalue:100000; defvalue:10000	SmartDeviceLink 1.0
vrHelp	VrHelpItem	Ability to send suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed.	N	Min = 1;Max = 100	SmartDeviceLink 2.0
interactionLayout	LayoutMode	See LayoutMode	N		SmartDeviceLink 3.0
cancelID	Integer	An ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.	N		SmartDeviceLink 6.0

Since:: SmartDeviceLink 1.0
See Also:: CreateInteractionChoiceSet, DeleteInteractionChoiceSet

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_CANCEL_ID`
`static String`	`KEY_HELP_PROMPT`
`static String`	`KEY_INITIAL_PROMPT`
`static String`	`KEY_INITIAL_TEXT`
`static String`	`KEY_INTERACTION_CHOICE_SET_ID_LIST`
`static String`	`KEY_INTERACTION_LAYOUT`
`static String`	`KEY_INTERACTION_MODE`
`static String`	`KEY_TIMEOUT`
`static String`	`KEY_TIMEOUT_PROMPT`
`static String`	`KEY_VR_HELP`

Fields inherited from class com.smartdevicelink.proxy.RPCRequest
onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage
function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`PerformInteraction()` Constructs a new PerformInteraction object
`PerformInteraction(Hashtable<String,Object> hash)` Constructs a new PerformInteraction object indicated by the Hashtable parameter
`PerformInteraction(String initialText, InteractionMode interactionMode, List<Integer> interactionChoiceSetIDList)` Constructs a new PerformInteraction object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getCancelID()` Gets an Integer value representing the cancel ID
`List<TTSChunk>`	`getHelpPrompt()` Gets a List which taken together, specify the help phrase to be spoken when the user says "help" during the VR session
`List<TTSChunk>`	`getInitialPrompt()` Gets an An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction
`String`	`getInitialText()` Gets the Text that Displayed when the interaction begins.
`List<Integer>`	`getInteractionChoiceSetIDList()` Gets a List value representing an Array of one or more Choice Set IDs
`LayoutMode`	`getInteractionLayout()` Gets the layout mode of how the choices are presented.
`InteractionMode`	`getInteractionMode()` Gets the Indicates mode that indicate how user selects interaction choice.
`Integer`	`getTimeout()` Gets a Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)
`List<TTSChunk>`	`getTimeoutPrompt()` Gets An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session
`List<VrHelpItem>`	`getVrHelp()` Gets a Voice Recognition Help list, which is a list of suggested VR Help Items to display on-screen during a Perform Interaction
`PerformInteraction`	`setCancelID(Integer cancelID)` Sets the cancel ID
`PerformInteraction`	`setHelpPrompt(List<TTSChunk> helpPrompt)` Sets An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session
`PerformInteraction`	`setInitialPrompt(List<TTSChunk> initialPrompt)` Sets An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction
`PerformInteraction`	`setInitialText(String initialText)` Sets the Text that Displayed when the interaction begins.
`PerformInteraction`	`setInteractionChoiceSetIDList(List<Integer> interactionChoiceSetIDList)` Sets a List representing an Array of one or more Choice Set IDs.
`PerformInteraction`	`setInteractionLayout(LayoutMode interactionLayout)` Sets the mode of how the choices are presented.
`PerformInteraction`	`setInteractionMode(InteractionMode interactionMode)` Sets the Indicates mode that indicate how user selects interaction choice.
`PerformInteraction`	`setTimeout(Integer timeout)` Sets the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu).
`PerformInteraction`	`setTimeoutPrompt(List<TTSChunk> timeoutPrompt)` Sets An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session
`PerformInteraction`	`setVrHelp(List<VrHelpItem> vrHelp)` Sets a Voice Recognition Help list, which is a list of suggested VR Help Items to display on-screen during a Perform Interaction

Methods inherited from class com.smartdevicelink.proxy.RPCRequest
getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage
getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_INITIAL_TEXT
```
public static final String KEY_INITIAL_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_INTERACTION_MODE
```
public static final String KEY_INTERACTION_MODE
```
    See Also:
    
    Constant Field Values
  - KEY_INTERACTION_CHOICE_SET_ID_LIST
```
public static final String KEY_INTERACTION_CHOICE_SET_ID_LIST
```
    See Also:
    
    Constant Field Values
  - KEY_INTERACTION_LAYOUT
```
public static final String KEY_INTERACTION_LAYOUT
```
    See Also:
    
    Constant Field Values
  - KEY_INITIAL_PROMPT
```
public static final String KEY_INITIAL_PROMPT
```
    See Also:
    
    Constant Field Values
  - KEY_HELP_PROMPT
```
public static final String KEY_HELP_PROMPT
```
    See Also:
    
    Constant Field Values
  - KEY_TIMEOUT_PROMPT
```
public static final String KEY_TIMEOUT_PROMPT
```
    See Also:
    
    Constant Field Values
  - KEY_TIMEOUT
```
public static final String KEY_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - KEY_VR_HELP
```
public static final String KEY_VR_HELP
```
    See Also:
    
    Constant Field Values
  - KEY_CANCEL_ID
```
public static final String KEY_CANCEL_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PerformInteraction
```
public PerformInteraction()
```
    Constructs a new PerformInteraction object
  - PerformInteraction
```
public PerformInteraction(Hashtable<String,Object> hash)
```
    Constructs a new PerformInteraction object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - PerformInteraction
```
public PerformInteraction(@NonNull
                          String initialText,
                          @NonNull
                          InteractionMode interactionMode,
                          @NonNull
                          List<Integer> interactionChoiceSetIDList)
```
    Constructs a new PerformInteraction object
    
    Parameters:
    
    initialText - a String value that is displayed when the interaction begins
    
    interactionMode - indicate how user selects interaction choice (VR_ONLY, MANUAL_ONLY or BOTH)
    
    interactionChoiceSetIDList - a List representing an Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets Notes: Min Value: 0; Max Value: 2000000000
- Method Detail
  - getInitialText
```
public String getInitialText()
```
    Gets the Text that Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated
    
    Returns:
    
    String -the text displayed when the interaction begins
  - setInitialText
```
public PerformInteraction setInitialText(@NonNull
                                         String initialText)
```
    Sets the Text that Displayed when the interaction begins. This text may be overlaid by the "Listening" prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated
    
    Parameters:
    
    initialText - a String value that Displayed when the interaction begins
  - getInitialPrompt
```
public List<TTSChunk> getInitialPrompt()
```
    Gets an An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction
    
    Returns:
    
    List -a List value, specify what is to be spoken to the user at the start of an interaction
  - setInitialPrompt
```
public PerformInteraction setInitialPrompt(List<TTSChunk> initialPrompt)
```
    Sets An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction
    
    Parameters:
    
    initialPrompt - a List value, specify what is to be spoken to the user at the start of an interaction
  - getInteractionMode
```
public InteractionMode getInteractionMode()
```
    Gets the Indicates mode that indicate how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH)
    
    Returns:
    
    InteractionMode -indicate how user selects interaction choice (VR_ONLY, MANUAL_ONLY or BOTH)
  - setInteractionMode
```
public PerformInteraction setInteractionMode(@NonNull
                                             InteractionMode interactionMode)
```
    Sets the Indicates mode that indicate how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH)
    
    Parameters:
    
    interactionMode - indicate how user selects interaction choice (VR_ONLY, MANUAL_ONLY or BOTH)
  - getInteractionChoiceSetIDList
```
public List<Integer> getInteractionChoiceSetIDList()
```
    Gets a List value representing an Array of one or more Choice Set IDs
    
    Returns:
    
    List -a List value representing an Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets
  - setInteractionChoiceSetIDList
```
public PerformInteraction setInteractionChoiceSetIDList(@NonNull
                                                        List<Integer> interactionChoiceSetIDList)
```
    Sets a List representing an Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets
    
    Parameters:
    
    interactionChoiceSetIDList - -a List representing an Array of one or more Choice Set IDs. User can select any choice from any of the specified Choice Sets
    Notes: Min Value: 0; Max Vlaue: 2000000000
  - getHelpPrompt
```
public List<TTSChunk> getHelpPrompt()
```
    Gets a List which taken together, specify the help phrase to be spoken when the user says "help" during the VR session
    
    Returns:
    
    List -a List which taken together, specify the help phrase to be spoken when the user says "help" during the VR session
  - setHelpPrompt
```
public PerformInteraction setHelpPrompt(List<TTSChunk> helpPrompt)
```
    Sets An array of TTSChunks which, taken together, specify the help phrase to be spoken when the user says "help" during the VR session
    If this parameter is omitted, the help prompt will be constructed by SDL from the first vrCommand of each choice of all the Choice Sets specified in the interactionChoiceSetIDList parameter
    Notes: The helpPrompt specified in SetGlobalProperties is not used by PerformInteraction
    
    Parameters:
    
    helpPrompt - a List which taken together, specify the help phrase to be spoken when the user says "help" during the VR session
  - getTimeoutPrompt
```
public List<TTSChunk> getTimeoutPrompt()
```
    Gets An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session
    
    Returns:
    
    List -a List specify the phrase to be spoken when the listen times out during the VR session
  - setTimeoutPrompt
```
public PerformInteraction setTimeoutPrompt(List<TTSChunk> timeoutPrompt)
```
    Sets An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session
    Notes: The timeoutPrompt specified in SetGlobalProperties is not used by PerformInteraction
    
    Parameters:
    
    timeoutPrompt - a List specify the phrase to be spoken when the listen times out during the VR session
  - getTimeout
```
public Integer getTimeout()
```
    Gets a Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)
    
    Returns:
    
    Integer -a Integer representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)
  - setTimeout
```
public PerformInteraction setTimeout(Integer timeout)
```
    Sets the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu). If this time elapses without the user making a choice, the timeoutPrompt will be spoken. After this timeout value has been reached, the interaction will stop and a subsequent interaction will take place after SDL speaks the timeout prompt. If that times out as well, the interaction will end completely. If omitted, the default is 10000ms
    
    Parameters:
    
    timeout - an Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)
    Notes: Min Value: 5000; Max Value: 100000
  - getVrHelp
```
public List<VrHelpItem> getVrHelp()
```
    Gets a Voice Recognition Help list, which is a list of suggested VR Help Items to display on-screen during a Perform Interaction
    
    Returns:
    
    List -a List value representing a suggested VR Help Items to display on-screen during Perform Interaction
    
    Since:
    
    SmartDeviceLink 2.0
  - setVrHelp
```
public PerformInteraction setVrHelp(List<VrHelpItem> vrHelp)
```
    Sets a Voice Recognition Help list, which is a list of suggested VR Help Items to display on-screen during a Perform Interaction
    
    Parameters:
    
    vrHelp - a List representing a suggested VR Help Items to display on-screen during Perform Interaction If omitted on supported displays, the default SDL generated list of suggested choices will be displayed
    Notes: Min=1; Max=100
    
    Since:
    
    SmartDeviceLink 2.0
  - getInteractionLayout
```
public LayoutMode getInteractionLayout()
```
    Gets the layout mode of how the choices are presented. For touchscreen interactions only.
    
    Returns:
    
    LayoutMode - The interaction layout mode
    
    Since:
    
    SmartDeviceLink 3.0
  - setInteractionLayout
```
public PerformInteraction setInteractionLayout(LayoutMode interactionLayout)
```
    Sets the mode of how the choices are presented. For touchscreen interactions only.
    
    Parameters:
    
    interactionLayout - A LayoutMode representing the interaction layout mode
    
    Since:
    
    SmartDeviceLink 3.0
  - getCancelID
```
public Integer getCancelID()
```
    Gets an Integer value representing the cancel ID
    
    Returns:
    
    Integer - An Integer value representing the ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.
    
    Since:
    
    SmartDeviceLink 6.0
  - setCancelID
```
public PerformInteraction setCancelID(Integer cancelID)
```
    Sets the cancel ID
    
    Parameters:
    
    cancelID - An Integer ID for this specific perform interaction to allow cancellation through the `CancelInteraction` RPC.
    
    Since:
    
    SmartDeviceLink 6.0

Class PerformInteraction

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_INITIAL_TEXT

KEY_INTERACTION_MODE

KEY_INTERACTION_CHOICE_SET_ID_LIST

KEY_INTERACTION_LAYOUT

KEY_INITIAL_PROMPT

KEY_HELP_PROMPT

KEY_TIMEOUT_PROMPT

KEY_TIMEOUT

KEY_VR_HELP

KEY_CANCEL_ID

Constructor Detail

PerformInteraction

PerformInteraction

PerformInteraction

Method Detail

getInitialText

setInitialText

getInitialPrompt

setInitialPrompt

getInteractionMode

setInteractionMode

getInteractionChoiceSetIDList

setInteractionChoiceSetIDList

getHelpPrompt

setHelpPrompt

getTimeoutPrompt

setTimeoutPrompt

getTimeout

setTimeout

getVrHelp

setVrHelp

getInteractionLayout

setInteractionLayout

getCancelID

setCancelID