summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2020-01-02 14:47:38 -0500
committerNicoleYarroch <nicole@livio.io>2020-01-02 14:47:38 -0500
commit12531d650f5a7e0f28430c30d3df2da288445738 (patch)
tree7b3480efa8614cbea7f6a6dc9ef4778ab7b872ec
parent13279be81cfe394afb2013d05c69e656c6a56509 (diff)
downloadsdl_ios-12531d650f5a7e0f28430c30d3df2da288445738.tar.gz
Added documentation
-rw-r--r--SmartDeviceLink/SDLLockScreenManager.h13
-rw-r--r--SmartDeviceLink/SDLLockScreenManager.m1
2 files changed, 13 insertions, 1 deletions
diff --git a/SmartDeviceLink/SDLLockScreenManager.h b/SmartDeviceLink/SDLLockScreenManager.h
index a63e42234..56ea270b3 100644
--- a/SmartDeviceLink/SDLLockScreenManager.h
+++ b/SmartDeviceLink/SDLLockScreenManager.h
@@ -15,6 +15,19 @@
NS_ASSUME_NONNULL_BEGIN
+/// Manages presenting and dismissing the lock screen based on several settings:
+/// 1. The lock screen configuration set by the developer. If the set to the default configuration, the lock screen manager will show or hide the lockscreen based on the the current `hmiLevel` of the SDL app and the current driver distraction (DD) status. However, the developer can also set the lockscreen to always show or not show at all.
+/// 2. Whether the passenger has dismissed the lockscreen (RPC v.6.0+). Once the passenger has dismissed the lockscreen, it will not be shown again during the same session.
+///
+/// | LockScreenStatus | HMILevel | DD |
+/// |------------------|----------------|-----|
+/// | OFF | HMI_NONE | - |
+/// | OFF | HMI_BACKGROUND | OFF |
+/// | REQUIRED | HMI_BACKGROUND | ON |
+/// | OPTIONAL | HMI_FULL | OFF |
+/// | REQUIRED | HMI_FULL | ON |
+/// | OPTIONAL | HMI_LIMITED | OFF |
+/// | REQUIRED | HMI_LIMITED | ON |
@interface SDLLockScreenManager : NSObject
/**
diff --git a/SmartDeviceLink/SDLLockScreenManager.m b/SmartDeviceLink/SDLLockScreenManager.m
index 8892e95d0..5dbb3e69f 100644
--- a/SmartDeviceLink/SDLLockScreenManager.m
+++ b/SmartDeviceLink/SDLLockScreenManager.m
@@ -163,7 +163,6 @@ NS_ASSUME_NONNULL_BEGIN
}
- (void)sdl_updatePresentation {
- // Present the VC depending on the lock screen status
if (self.config.displayMode == SDLLockScreenConfigurationDisplayModeAlways) {
if (self.canPresent) {
[self.presenter updateLockScreenToShow:YES];