summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h30
1 files changed, 29 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h
index d2f67d517..9ef286e77 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLResetGlobalProperties.h
@@ -1,15 +1,43 @@
// SDLResetGlobalProperties.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
+
#import "SDLRPCRequest.h"
+/**
+ * Resets the passed global properties to their default values as defined by
+ * SDL
+ * <p>
+ * The HELPPROMPT global property default value is generated by SDL consists of
+ * the first vrCommand of each Command Menu item defined at the moment PTT is
+ * pressed<br/>
+ * The TIMEOUTPROMPT global property default value is the same as the HELPPROMPT
+ * global property default value
+ * <p>
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
+ * </p>
+ *
+ * Since SmartDeviceLink 1.0
+ * See SetGlobalProperties
+ */
@interface SDLResetGlobalProperties : SDLRPCRequest {}
+/**
+ * @abstract Constructs a new SDLResetGlobalProperties object
+ */
-(id) init;
+/**
+ * @abstract Constructs a new SDLResetGlobalProperties object indicated by the NSMutableDictionary
+ * parameter
+ * @param dict The NSMutableDictionary to use
+ */
-(id) initWithDictionary:(NSMutableDictionary*) dict;
+/**
+ * @abstract An array of one or more GlobalProperty enumeration elements
+ * indicating which global properties to reset to their default value
+ */
@property(strong) NSMutableArray* properties;
@end