summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLConfiguration.h
diff options
context:
space:
mode:
authorJoel Fischer <joeljfischer@gmail.com>2016-07-01 13:34:48 -0400
committerJoel Fischer <joeljfischer@gmail.com>2016-07-01 13:34:48 -0400
commitf8743371db8902925b441e85ce658f34f0af03d5 (patch)
treeeb3b3d1e6f26be24e8395635525707dd8e1e0bbf /SmartDeviceLink/SDLConfiguration.h
parent58118b12be90e3138c4971dc08bf095ea77e4880 (diff)
downloadsdl_ios-f8743371db8902925b441e85ce658f34f0af03d5.tar.gz
Add SDLConfiguration tests
* Add SDLConfiguration documentation
Diffstat (limited to 'SmartDeviceLink/SDLConfiguration.h')
-rw-r--r--SmartDeviceLink/SDLConfiguration.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/SmartDeviceLink/SDLConfiguration.h b/SmartDeviceLink/SDLConfiguration.h
index 1c29db518..f5aacd71a 100644
--- a/SmartDeviceLink/SDLConfiguration.h
+++ b/SmartDeviceLink/SDLConfiguration.h
@@ -18,8 +18,24 @@ NS_ASSUME_NONNULL_BEGIN
@property (copy, nonatomic, readonly) SDLLifecycleConfiguration *lifecycleConfig;
@property (copy, nonatomic, readonly) SDLLockScreenConfiguration *lockScreenConfig;
-
+/**
+ * Create a new configuration to be passed into SDLManager.
+ *
+ * @param lifecycleConfig The lifecycle configuration to be used.
+ * @param lockScreenConfig The lockscreen configuration to be used. If nil, this will be `enabledConfiguration`.
+ *
+ * @return The configuration
+ */
- (instancetype)initWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig;
+
+/**
+ * Create a new configuration to be passed into SDLManager.
+ *
+ * @param lifecycleConfig The lifecycle configuration to be used.
+ * @param lockScreenConfig The lockscreen configuration to be used. If nil, this will be `enabledConfiguration`.
+ *
+ * @return The configuration
+ */
+ (instancetype)configurationWithLifecycle:(SDLLifecycleConfiguration *)lifecycleConfig lockScreen:(nullable SDLLockScreenConfiguration *)lockScreenConfig;
@end