Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLPerformInteraction Class Reference

Section Contents

Overview

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

-initWithInteractionChoiceSetId:

Undocumented

Objective-C

- (instancetype)initWithInteractionChoiceSetId:(UInt16)interactionChoiceSetId;

Swift

init(interactionChoiceSetId: UInt16)

-initWithInteractionChoiceSetIdList:

Undocumented

Objective-C

- (instancetype)initWithInteractionChoiceSetIdList:(NSArray<NSNumber<SDLUInt> *> *)interactionChoiceSetIdList;

Swift

init(interactionChoiceSetIdList: [NSNumber & SDLUInt])

-initWithInitialPrompt:initialText:interactionChoiceSetID:

Undocumented

Objective-C

- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetID:(UInt16)interactionChoiceSetID;

Swift

init(initialPrompt: String?, initialText: String, interactionChoiceSetID: UInt16)

-initWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:

Undocumented

Objective-C

- (instancetype)initWithInitialPrompt:(nullable NSString *)initialPrompt initialText:(NSString *)initialText interactionChoiceSetID:(UInt16)interactionChoiceSetID vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp;

Swift

init(initialPrompt: String?, initialText: String, interactionChoiceSetID: UInt16, vrHelp: [SDLVRHelpItem]?)

-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:

Undocumented

Objective-C

- (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;

Swift

init(initialPrompt: String?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], helpPrompt: String?, timeoutPrompt: String?, interactionMode: SDLInteractionMode, timeout: UInt32)

-initWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:

Undocumented

Objective-C

- (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;

Swift

init(initialPrompt: String?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], helpPrompt: String?, timeoutPrompt: String?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?)

-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:

Undocumented

Objective-C

- (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;

Swift

init(initialChunks: [SDLTTSChunk]?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], help helpChunks: [SDLTTSChunk]?, timeoutChunks: [SDLTTSChunk]?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?)

-initWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:interactionLayout:

Undocumented

Objective-C

- (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;

Swift

init(initialChunks: [SDLTTSChunk]?, initialText: String, interactionChoiceSetIDList: [NSNumber & SDLUInt], help helpChunks: [SDLTTSChunk]?, timeoutChunks: [SDLTTSChunk]?, interactionMode: SDLInteractionMode, timeout: UInt32, vrHelp: [SDLVRHelpItem]?, interactionLayout layout: SDLLayoutMode?)

initialText

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

Objective-C

@property (readwrite, strong, nonatomic) NSString *_Nonnull initialText;

Swift

var initialText: String { get set }

initialPrompt

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

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLTTSChunk *> *initialPrompt;

Swift

var initialPrompt: [SDLTTSChunk]? { get set }

interactionMode

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)

Objective-C

@property (readwrite, strong, nonatomic)
    SDLInteractionMode _Nonnull interactionMode;

Swift

var interactionMode: SDLInteractionMode { get set }

interactionChoiceSetIDList

A Vector value representing an Array of one or more Choice Set IDs

Objective-C

@property (readwrite, strong, nonatomic)
    NSArray<NSNumber<SDLInt> *> *_Nonnull interactionChoiceSetIDList;

Swift

var interactionChoiceSetIDList: [NSNumber & SDLInt] { get set }

helpPrompt

A Vector which taken together, specify the help phrase to be spoken when the user says help during the VR session

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLTTSChunk *> *helpPrompt;

Swift

var helpPrompt: [SDLTTSChunk]? { get set }

timeoutPrompt

An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLTTSChunk *> *timeoutPrompt;

Swift

var timeoutPrompt: [SDLTTSChunk]? { get set }

timeout

An Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)

Objective-C

@property (readwrite, strong, nonatomic, nullable) NSNumber<SDLInt> *timeout;

Swift

var timeout: (NSNumber & SDLInt)? { get set }

vrHelp

A Voice recognition Help, which is a suggested VR Help Items to display on-screen during Perform Interaction @since SmartDeviceLink 2.0

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SDLVRHelpItem *> *vrHelp;

Swift

var vrHelp: [SDLVRHelpItem]? { get set }

interactionLayout

Undocumented

Objective-C

@property (nullable, strong, nonatomic) SDLLayoutMode interactionLayout

Swift

var interactionLayout: SDLLayoutMode? { get set }
View on GitHub.com
Previous Section Next Section