summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLLockScreenPresenter.m
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2019-12-18 16:13:44 -0500
committerNicoleYarroch <nicole@livio.io>2019-12-18 16:13:44 -0500
commit86d54ea140f212ea07971b3c8b3630c8d7dab6ae (patch)
tree1d258e507a8dc6ff3b3b96946524f2d1ce3b6e63 /SmartDeviceLink/SDLLockScreenPresenter.m
parented00b032fe45884ff9953e781b7874a31b06099b (diff)
downloadsdl_ios-86d54ea140f212ea07971b3c8b3630c8d7dab6ae.tar.gz
Added more documentation
Diffstat (limited to 'SmartDeviceLink/SDLLockScreenPresenter.m')
-rw-r--r--SmartDeviceLink/SDLLockScreenPresenter.m3
1 files changed, 3 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLLockScreenPresenter.m b/SmartDeviceLink/SDLLockScreenPresenter.m
index fa82a9a94..bc2260c4a 100644
--- a/SmartDeviceLink/SDLLockScreenPresenter.m
+++ b/SmartDeviceLink/SDLLockScreenPresenter.m
@@ -49,7 +49,10 @@ NS_ASSUME_NONNULL_BEGIN
}];
}
+/// Shows or hides the lock screen with an animation. If the lockscreen is shown/dismissed in rapid succession the final state of the lock screen may not match the expected state as the order in which the animations finish can be random. To guard against this scenario, store the expected state of the lock screen. When the animation finishes, check the expected state to make sure that the final state of the lock screen matches the expected state. If not perform a final animation to the expected state.
+/// @param show True if the lock screen should be shown; false if it should be dismissed
- (void)updateLockScreenToShow:(BOOL)show {
+ // Store the expected state of the lock screen
self.showLockScreen = show;
if (show) {