summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h29
1 files changed, 28 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h
index 2e62fc216..76ee00002 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLUnsubscribeButton.h
@@ -1,17 +1,44 @@
// SDLUnsubscribeButton.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
#import "SDLRPCRequest.h"
#import "SDLButtonName.h"
+/**
+ * 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
+ */
-(id) init;
+/**
+ * @abstract Constructs a new SDLUnsubscribeButton object indicated by the NSMutableDictionary
+ * parameter
+ * @param dict The NSMutableDictionary to use
+ */
-(id) 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
+