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
|
// SDLSubscribeButton.h
//
#import "SDLRPCRequest.h"
#import "SDLButtonName.h"
#import "SDLRequestHandler.h"
/**
* Establishes a subscription to button notifications for HMI buttons. Buttons
* are not necessarily physical buttons, but can also be "soft" buttons on a
* touch screen, depending on the display in the vehicle. Once subscribed to a
* particular button, an application will receive both
* SDLOnButtonEvent and SDLOnButtonPress notifications
* whenever that button is pressed. The application may also unsubscribe from
* notifications for a button by invoking the SDLUnsubscribeButton
* operation
* <p>
* When a button is depressed, an SDLOnButtonEvent notification is
* sent to the application with a ButtonEventMode of BUTTONDOWN. When that same
* button is released, an SDLOnButtonEvent notification is sent to the
* application with a ButtonEventMode of BUTTONUP
* <p>
* When the duration of a button depression (that is, time between depression
* and release) is less than two seconds, an SDLOnButtonPress
* notification is sent to the application (at the moment the button is
* released) with a ButtonPressMode of SHORT. When the duration is two or more
* seconds, an SDLOnButtonPress notification is sent to the
* application (at the moment the two seconds have elapsed) with a
* ButtonPressMode of LONG
* <p>
* The purpose of SDLOnButtonPress notifications is to allow for
* programmatic detection of long button presses similar to those used to store
* presets while listening to the radio, for example
* <p>
* When a button is depressed and released, the sequence in which notifications
* will be sent to the application is as follows:
* <p>
* For short presses:<br/>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = SHORT)</li>
* </ul>
* <p>
* For long presses:<br/>
* <ul>
* <li>OnButtonEvent (ButtonEventMode = BUTTONDOWN)</li>
* <li>OnButtonEvent (ButtonEventMode = BUTTONUP)</li>
* <li>OnButtonPress (ButtonPressMode = LONG)</li>
* </ul>
* <p>
* <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
* </p>
*
* Since SmartDeviceLink 1.0<br/>
* See SDLUnsubscribeButton
*/
@interface SDLSubscribeButton : SDLRPCRequest <SDLRequestHandler>
/**
* Construct a SDLSubscribeButton with a handler callback when an event occurs.
*
* @param handler A callback that will be called when a button event occurs for the subscribed button.
*
* @return An SDLSubscribeButton object
*/
- (instancetype)initWithHandler:(SDLRPCNotificationHandler)handler;
- (instancetype)initWithButtonName:(SDLButtonName)buttonName handler:(SDLRPCNotificationHandler)handler;
/**
* A handler that will let you know when the button you subscribed to is selected.
*
* @warning This will only work if you use SDLManager.
*/
@property (copy, nonatomic) SDLRPCNotificationHandler handler;
/**
* @abstract The name of the button to subscribe to
* @discussion An enum value, see <i>SDLButtonName</i>
*/
@property (strong) SDLButtonName buttonName;
@end
|
