summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
blob: 4fce3ba164ff2a0b15c00008cc7554972f57bc96 (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
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
//  SDLAppInterfaceUnregisteredReason.h
//


#import "SDLEnum.h"

/**
 * Indicates reason why app interface was unregistered. The application is being disconnected by SDL.
 *
 * @since SDL 1.0
 */
@interface SDLAppInterfaceUnregisteredReason : SDLEnum {
}

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

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

/**
 * @abstract Vehicle ignition turned off.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *IGNITION_OFF*
 */
+ (SDLAppInterfaceUnregisteredReason *)IGNITION_OFF;

/**
 * @abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *BLUETOOTH_OFF*
 */
+ (SDLAppInterfaceUnregisteredReason *)BLUETOOTH_OFF;

/**
 * @abstract USB was disconnected, causing termination of a necessary iAP connection.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *USB_DISCONNECTED*
 */
+ (SDLAppInterfaceUnregisteredReason *)USB_DISCONNECTED;

/**
 * @abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *REQUEST_WHILE_IN_NONE_HMI_LEVEL*
 */
+ (SDLAppInterfaceUnregisteredReason *)REQUEST_WHILE_IN_NONE_HMI_LEVEL;

/**
 * @abstract Either too many -- or too many per unit of time -- requests were made by the application.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *TOO_MANY_REQUESTS*
 */
+ (SDLAppInterfaceUnregisteredReason *)TOO_MANY_REQUESTS;

/**
 * @abstract The application has issued requests which cause driver distraction rules to be violated.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *DRIVER_DISTRACTION_VIOLATION*
 */
+ (SDLAppInterfaceUnregisteredReason *)DRIVER_DISTRACTION_VIOLATION;

/**
 *  @abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.
 *
 *  @return SDLAppInterfaceUnregisteredReason with value *LANGUAGE_CHANGE*
 */
+ (SDLAppInterfaceUnregisteredReason *)LANGUAGE_CHANGE;

/**
 * @abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *MASTER_RESET*
 */
+ (SDLAppInterfaceUnregisteredReason *)MASTER_RESET;

/**
 * @abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *FACTORY_DEFAULTS*
 */
+ (SDLAppInterfaceUnregisteredReason *)FACTORY_DEFAULTS;

/**
 * @abstract The app is not being authorized to be connected to SDL.
 *
 * @return SDLAppInterfaceUnregisteredReason with value *APP_UNAUTHORIZED*
 *
 * @since SDL 2.0
 */
+ (SDLAppInterfaceUnregisteredReason *)APP_UNAUTHORIZED;

@end