1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
// SDLSetGlobalProperties.h
//
#import "SDLRPCRequest.h"
@class SDLImage;
@class SDLKeyboardProperties;
@class SDLTTSChunk;
@class SDLVRHelpItem;
NS_ASSUME_NONNULL_BEGIN
/**
Sets global property values
Since SmartDeviceLink 1.0
See SDLResetGlobalProperties
*/
@interface SDLSetGlobalProperties : SDLRPCRequest
/**
Initialize SetGlobalProperties with help text and timeout text
@param helpText A string that will be turned into TTS chunks for the help prompt
@param timeoutText A string that will be turned into TTS chunks for the timeout prompt
@return The SetGlobalProperties RPC
*/
- (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText;
/**
Initialize SetGlobalProperties with help text, timeout text, help title, and help items
@param helpText A string that will be turned into TTS chunks for the help prompt
@param timeoutText A string that will be turned into TTS chunks for the timeout prompt
@param vrHelpTitle The title of the help interface prompt
@param vrHelp The items of the help interface prompt
@return The SetGlobalProperties RPC
*/
- (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp;
/**
Initialize SetGlobalProperties with all possible items
@param helpText A string that will be turned into TTS chunks for the help prompt
@param timeoutText A string that will be turned into TTS chunks for the timeout prompt
@param vrHelpTitle The title of the help interface prompt
@param vrHelp The items of the help interface prompt
@param menuTitle The title of the menu button
@param menuIcon The icon on the menu button
@param keyboardProperties The properties of a keyboard prompt
@return The SetGlobalProperties RPC
*/
- (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp menuTitle:(nullable NSString *)menuTitle menuIcon:(nullable SDLImage *)menuIcon keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties;
/**
Help prompt for when the user asks for help with an interface prompt
Optional
*/
@property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *helpPrompt;
/**
Help prompt for when an interface prompt times out
Optional, Array, at least 1 item
*/
@property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *timeoutPrompt;
/**
Sets a voice recognition Help Title
Optional
*/
@property (strong, nonatomic, nullable) NSString *vrHelpTitle;
/**
Sets the items listed in the VR help screen used in an interaction started by Push to Talk
@since SmartDeviceLink 2.0
Optional
*/
@property (strong, nonatomic, nullable) NSArray<SDLVRHelpItem *> *vrHelp;
/**
Text for the menu button label
Optional
*/
@property (strong, nonatomic, nullable) NSString *menuTitle;
/**
Icon for the menu button
Optional
*/
@property (strong, nonatomic, nullable) SDLImage *menuIcon;
/**
On-screen keyboard (perform interaction) configuration
Optional
*/
@property (strong, nonatomic, nullable) SDLKeyboardProperties *keyboardProperties;
@end
NS_ASSUME_NONNULL_END
|
