summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLOnDriverDistraction.h
blob: 5d9a9b3a2aaf598e6923e1c4b189c29a7b9582f1 (plain)
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
//  SDLOnDriverDistraction.h
//



#import "SDLRPCNotification.h"

#import "SDLDriverDistractionState.h"

/**
 * <p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or
 * not).</p>
 *
 * <p></p>
 * <b>HMI Status Requirements:</b>
 * <ul>
 * HMILevel:
 * <ul><li>Can be sent with FULL, LIMITED or BACKGROUND</li></ul>
 * AudioStreamingState:
 * <ul><li>Any</li></ul>
 * SystemContext:
 * <ul><li>Any</li></ul>
 * </ul>
 * <p></p>
 * <b>Parameter List:</b>
 * <table  border="1" rules="all">
 *     <tr>
 *         <th>Name</th>
 *         <th>Type</th>
 *         <th>Description</th>
 *         <th>SmartDeviceLink Ver Available</th>
 *     </tr>
 *     <tr>
 *         <td>state</td>
 *         <td>SDLDriverDistractionState* </td>
 *         <td>Current driver distraction <i>state</i>(i.e. whether driver distraction rules are in effect, or not). </td>
 *         <td>SmartDeviceLink 1.0</td>
 *     </tr>
 * </table>
 * Since <b>SmartDeviceLink 1.0</b>
 */
@interface SDLOnDriverDistraction : SDLRPCNotification {}

/**
 *Constructs a newly allocated SDLOnDriverDistraction object
 */
-(id) init;
/**
 *<p>Constructs a newly allocated SDLOnDriverDistraction object indicated by the NSMutableDictionary parameter</p>
 *@param dict The NSMutableDictionary to use
 */
-(id) initWithDictionary:(NSMutableDictionary*) dict;

/**
 * @abstract the driver distraction state(i.e. whether driver distraction rules are in effect, or not)
 * @discussion
 */
@property(strong) SDLDriverDistractionState* state;

@end