summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeviceLevelStatus.h
blob: e0cb85aeaf152f44506084e4c2e1aebcc0bff928 (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
//  SDLDeviceLevelStatus.h
//


#import "SDLEnum.h"

/**
 * Reflects the reported battery status of the connected device, if reported.
 *
 * @since SDL 2.0
 */
@interface SDLDeviceLevelStatus : SDLEnum {
}

/**
 * Convert String to DeviceLevelStatus
 * @param value String
 * @return DeviceLevelStatus
 */
+ (SDLDeviceLevelStatus *)valueOf:(NSString *)value;

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

/**
 * @abstract Device battery level is zero bars
 * @return a SDLDeviceLevelStatus with value of *ZERO_LEVEL_BARS*
 */
+ (SDLDeviceLevelStatus *)ZERO_LEVEL_BARS;

/**
 * @abstract Device battery level is one bar
 * @return a SDLDeviceLevelStatus with value of *ONE_LEVEL_BARS*
 */
+ (SDLDeviceLevelStatus *)ONE_LEVEL_BARS;

/**
 * @abstract Device battery level is two bars
 * @return a SDLDeviceLevelStatus with value of *TWO_LEVEL_BARS*
 */
+ (SDLDeviceLevelStatus *)TWO_LEVEL_BARS;

/**
 * @abstract Device battery level is three bars
 * @return a SDLDeviceLevelStatus with value of *THREE_LEVEL_BARS*
 */
+ (SDLDeviceLevelStatus *)THREE_LEVEL_BARS;

/**
 * @abstract Device battery level is four bars
 * @return a SDLDeviceLevelStatus with value of *FOUR_LEVEL_BARS*
 */
+ (SDLDeviceLevelStatus *)FOUR_LEVEL_BARS;

/**
 * @abstract Device battery level is unknown
 * @return a SDLDeviceLevelStatus with value of *NOT_PROVIDED*
 */
+ (SDLDeviceLevelStatus *)NOT_PROVIDED;

@end