Performs an application-initiated interaction in which the user can select a {@linkplain 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
Function Group: Base
HMILevel needs to be FULL
Since SmartDeviceLink 1.0
See SDLCreateInteractionChoiceSet SDLDeleteInteractionChoiceSet
Undocumented
- (instancetype)initWithInteractionChoiceSetId:(UInt16)interactionChoiceSetId;
init(interactionChoiceSetId: UInt16)
Undocumented
- (instancetype)initWithInteractionChoiceSetIdList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIdList;
init(interactionChoiceSetIdList: [NSNumber & SDLUInt])
Undocumented
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetID:(UInt16)interactionChoiceSetID;
init(initialPrompt: String?, initialText: String, interactionChoiceSetID: UInt16)
Undocumented
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetID:(UInt16)interactionChoiceSetID vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp;
init(initialPrompt: String?, initialText: String, interactionChoiceSetID: UInt16, vrHelp: [SDLVRHelpItem]?)
Undocumented
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetIDList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIDList helpPrompt:(nullable NSString *)helpPrompt timeoutPrompt:(nullable NSString *)timeoutPrompt interactionMode:(SDLInteractionMode)interactionMode timeout:(UInt32)timeout;
init(initialPrompt: String?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], helpPrompt: String?, timeoutPrompt: String?, interactionMode: SDLInteractionMode, timeout: UInt32)
Undocumented
- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetIDList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIDList helpPrompt:(nullable NSString *)helpPrompt timeoutPrompt:(nullable NSString *)timeoutPrompt interactionMode:(SDLInteractionMode)interactionMode timeout:(UInt32)timeout vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp;
init(initialPrompt: String?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], helpPrompt: String?, timeoutPrompt: String?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?)
Undocumented
- (instancetype)initWithInitialChunks:(nullable NSArray<SDLTTSChunk *> *)initialChunks initialText:(NSString *)initialText interactionChoiceSetIDList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIDList helpChunks:(nullable NSArray<SDLTTSChunk *> *)helpChunks timeoutChunks:(nullable NSArray<SDLTTSChunk *> *)timeoutChunks interactionMode:(SDLInteractionMode)interactionMode timeout:(UInt32)timeout vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp;
init(initialChunks: [SDLTTSChunk]?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], help helpChunks: [SDLTTSChunk]?, timeoutChunks: [SDLTTSChunk]?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?)
Undocumented
- (instancetype)initWithInitialChunks:(nullable NSArray<SDLTTSChunk *> *)initialChunks initialText:(NSString *)initialText interactionChoiceSetIDList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIDList helpChunks:(nullable NSArray<SDLTTSChunk *> *)helpChunks timeoutChunks:(nullable NSArray<SDLTTSChunk *> *)timeoutChunks interactionMode:(SDLInteractionMode)interactionMode timeout:(UInt32)timeout vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp interactionLayout:(nullable SDLLayoutMode)layout;
init(initialChunks: [SDLTTSChunk]?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], help helpChunks: [SDLTTSChunk]?, timeoutChunks: [SDLTTSChunk]?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?, interactionLayout layout: SDLLayoutMode?)
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
@property (readwrite, strong, nonatomic) NSString *_Nonnull initialText;
var initialText: String { get set }
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
@property (readwrite, strong, nonatomic, nullable)
NSArray<SDLTTSChunk *> *initialPrompt;
var initialPrompt: [SDLTTSChunk]? { get set }
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)
@property (readwrite, strong, nonatomic)
SDLInteractionMode _Nonnull interactionMode;
var interactionMode: SDLInteractionMode { get set }
A Vector
@property (readwrite, strong, nonatomic)
NSArray<NSNumber<SDLInt> *> *_Nonnull interactionChoiceSetIDList;
var interactionChoiceSetIDList: [NSNumber & SDLInt] { get set }
A Vectorhelp
during the VR session
@property (readwrite, strong, nonatomic, nullable)
NSArray<SDLTTSChunk *> *helpPrompt;
var helpPrompt: [SDLTTSChunk]? { get set }
An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session
@property (readwrite, strong, nonatomic, nullable)
NSArray<SDLTTSChunk *> *timeoutPrompt;
var timeoutPrompt: [SDLTTSChunk]? { get set }
An Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)
@property (readwrite, strong, nonatomic, nullable) NSNumber<SDLInt> *timeout;
var timeout: (NSNumber & SDLInt)? { get set }
A Voice recognition Help, which is a suggested VR Help Items to display on-screen during Perform Interaction @since SmartDeviceLink 2.0
@property (readwrite, strong, nonatomic, nullable)
NSArray<SDLVRHelpItem *> *vrHelp;
var vrHelp: [SDLVRHelpItem]? { get set }
Undocumented
@property (nullable, strong, nonatomic) SDLLayoutMode interactionLayout
var interactionLayout: SDLLayoutMode? { get set }