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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
// SDLAlert.h
//
#import "SDLRPCRequest.h"
/**
* Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.
*
* <ul>
* <li>The displayed portion of the SDLAlert, if any, will persist until the
* specified timeout has elapsed, or the SDLAlert is preempted</li>
* <li>An SDLAlert will preempt (abort) any SmartDeviceLink Operation that is in-progress,
* except an already-in-progress SDLAlert</li>
* <li>An SDLAlert cannot be preempted by any SmartDeviceLink Operation</li>
* <li>An SDLAlert can be preempted by a user action (button push)</li>
* <li>An SDLAlert will fail if it is issued while another SDLAlert is in progress</li>
* <li>Although each Alert parameter is optional, in fact each SDLAlert request
* must supply at least one of the following parameters:<br/>
* <ul>
* <li>alertText1</li>
* <li>alertText2</li>
* <li>alertText3</li>
* <li>ttsChunks</li>
* </ul>
* </li>
* </ul>
* <br/>
* <b>HMILevel needs to be FULL or LIMITED.</b><br/>
* <b>If the app has been granted function group Notification the SDLHMILevel can
* also be BACKGROUND</b><br/>
*
* @since SDL 1.0
*/
@interface SDLAlert : SDLRPCRequest {
}
/**
* Constructs a new SDLAlert object
*/
- (instancetype)init;
/**
* Constructs a new SDLAlert object indicated by the dictionary parameter
*
* @param dict The dictionary to use
*/
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;
/**
* @abstract The String to be displayed in the first field of the display during the Alert
*
* @discussion Length is limited to what is indicated in *SDLRegisterAppInterface* response
*
* If omitted, top display line will be cleared
*
* Text is always centered
*
* Optional, Max length 500 chars
*/
@property (strong) NSString *alertText1;
/**
* @abstract The String to be displayed in the second field of the display during the Alert
*
* @discussion Only permitted if HMI supports a second display line
*
* Length is limited to what is indicated in *SDLRegisterAppInterface* response
*
* If omitted, second display line will be cleared
*
* Text is always centered
*
* Optional, Max length 500 chars
*/
@property (strong) NSString *alertText2;
/**
* @abstract the String to be displayed in the third field of the display during the Alert
* @discussion Only permitted if HMI supports a third display line
*
* Length is limited to what is indicated in *SDLRegisterAppInterface* response
*
* If omitted, third display line will be cleared
*
* Text is always centered
*
* Optional, Max length 500 chars
*/
@property (strong) NSString *alertText3;
/**
* @abstract An array which, taken together, specify what is to be spoken to the user
*
* Optional, Array of SDLTTSChunk, Array length 1 - 100
*
* @see SDLTTSChunk
*/
@property (strong) NSMutableArray *ttsChunks;
/**
* @abstract The duration of the displayed portion of the alert, in milliseconds.
*
* @discussion After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.
*
* Typical timeouts are 3 - 5 seconds
*
* If omitted, the timeout is set to 5 seconds
*
* Optional, Integer, 3000 - 10000
*/
@property (strong) NSNumber *duration;
/**
* @abstract Whether the alert tone should be played before the TTS (if any) is spoken.
*
* @discussion If ommitted, no tone is played
*
* Optional, Boolean
*/
@property (strong) NSNumber *playTone;
/**
* @abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.
*
* Optional, Boolean
*
* @since SmartDeviceLink 2.0
*/
@property (strong) NSNumber *progressIndicator;
/**
* @abstract App defined SoftButtons.
*
* @discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons
*
* Optional, Array of SDLSoftButton, Array size 0 - 4
*
* @see SDLSoftButton
*/
@property (strong) NSMutableArray *softButtons;
@end
|
