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

#import "SDLRPCRequest.h"

@class SDLButtonName;


/**
 * Deletes a subscription to button notifications for the specified button. For
 * more information about button subscriptions, see SDLSubscribeButton
 * <p>
 * Application can unsubscribe from a button that is currently being pressed
 * (i.e. has not yet been released), but app will not get button event
 * <p>
 * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
 * <p>
 
 * @since SmartDeviceLink 1.0<br/>
 * See SDLSubscribeButton
 */
@interface SDLUnsubscribeButton : SDLRPCRequest {
}

/**
 * @abstract Constructs a new SDLUnsubscribeButton object
 */
- (instancetype)init;
/**
 * @abstract Constructs a new SDLUnsubscribeButton object indicated by the NSMutableDictionary
 * parameter
 * @param dict The dictionary to use
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;

/**
 * @abstract A name of the button to unsubscribe from
 * @discussion An Enumeration value, see <i>
 *         SDLButtonName</i>
 */
@property (strong) SDLButtonName *buttonName;

@end