summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLSystemContext.h
blob: 89e92e420bf18ee0cba6cfb5648838931b6f9823 (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
61
62
63
64
65
66
67
68
69
70
//  SDLSystemContext.h
//


#import "SDLEnum.h"

/**
 * Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR).
 *
 * @since SDL 1.0
 */
@interface SDLSystemContext : SDLEnum {
}

/**
 * Convert String to SDLSystemContext
 *
 * @param value String value to retrieve the object for
 *
 * @return SDLSystemContext
 */
+ (SDLSystemContext *)valueOf:(NSString *)value;

/**
 *  @abstract Store the enumeration of all possible SDLSystemContext
 *
 *  @return an array that store all possible SDLSystemContext
 */
+ (NSArray *)values;

/**
 * @abstract No user interaction (user-initiated or app-initiated) is in progress.
 *
 * @return SDLSystemContext object of value *MAIN*
 */
+ (SDLSystemContext *)MAIN;

/**
 * @abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.
 *
 * @return SDLSystemContext object of value *VRSESSION*
 */
+ (SDLSystemContext *)VRSESSION;

/**
 * @abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress.
 *
 * @return SDLSystemContext object of value *MENU*
 */
+ (SDLSystemContext *)MENU;

/**
 * @abstract The app's display HMI is currently being obscured by either a system or other app's overlay.
 *
 * @return SDLSystemContext object of value *HMI_OBSCURED*
 *
 * @since SDL 2.0
 */
+ (SDLSystemContext *)HMI_OBSCURED;

/**
 * @abstract Broadcast only to whichever app has an alert currently being displayed.
 *
 * @return SDLSystemContext object of value *ALERT*
 *
 * @since SDL 2.0
 */
+ (SDLSystemContext *)ALERT;

@end