summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLLockScreenConfiguration.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLLockScreenConfiguration.html')
-rw-r--r--docs/Classes/SDLLockScreenConfiguration.html11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/Classes/SDLLockScreenConfiguration.html b/docs/Classes/SDLLockScreenConfiguration.html
index c92ae2525..68238843e 100644
--- a/docs/Classes/SDLLockScreenConfiguration.html
+++ b/docs/Classes/SDLLockScreenConfiguration.html
@@ -25,7 +25,16 @@
showInOptionalState
</h3>
- <p>Whether or not the lock screen should be shown in the <q>lock screen optional</q> state. Defaults to &lsquo;NO&rsquo;.</p>
+ <p>Whether or not the lock screen should be shown in the <q>lock screen optional</q> state. Defaults to false.</p>
+
+<p>@discussion In order for the <q>lock screen optional</q> state to occur, the following must be true:</p>
+
+<ol>
+<li>The app should have received at least 1 driver distraction notification (i.e. a <code>OnDriverDistraction</code> notification) from SDL Core. Older versions of Core did not send a notification immediately on connection.</li>
+<li>The driver is not distracted (i.e. the last <code>OnDriverDistraction</code> notification received was for a driver distraction state off).</li>
+<li>The <code>hmiLevel</code> can not be <code>NONE</code>.</li>
+<li>If the <code>hmiLevel</code> is currently <code>BACKGROUND</code> then the previous <code>hmiLevel</code> should have been <code>FULL</code> or <code>LIMITED</code> (i.e. the user should have interacted with app before it was backgrounded).</li>
+</ol>