summaryrefslogtreecommitdiff
path: root/docs/Enums/SDLLockScreenConfigurationDisplayMode.html
blob: 89a5ea5127fd9ac29939dfe3b6e9f25fda53e16f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<h1>SDLLockScreenConfigurationDisplayMode Enumeration Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-SDLLockScreenConfigurationDisplayModeNever">SDLLockScreenConfigurationDisplayModeNever</a></li>
  <li><a href="#section-SDLLockScreenConfigurationDisplayModeRequiredOnly">SDLLockScreenConfigurationDisplayModeRequiredOnly</a></li>
  <li><a href="#section-SDLLockScreenConfigurationDisplayModeOptionalOrRequired">SDLLockScreenConfigurationDisplayModeOptionalOrRequired</a></li>
  <li><a href="#section-SDLLockScreenConfigurationDisplayModeAlways">SDLLockScreenConfigurationDisplayModeAlways</a></li>
</ul>

<h3>Overview</h3>

<p>Describes when the lock screen should be shown.</p>


<section class="section task-group-section">
  <h3 id="section-SDLLockScreenConfigurationDisplayModeNever">
      SDLLockScreenConfigurationDisplayModeNever
  </h3>
  
  <p>The lock screen should never be shown. This should almost always mean that you will build your own lock screen.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLockScreenConfigurationDisplayModeNever</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">never</span> <span class="o">=</span> <span class="mi">0</span></code></pre>

  
  
  
  <h3 id="section-SDLLockScreenConfigurationDisplayModeRequiredOnly">
      SDLLockScreenConfigurationDisplayModeRequiredOnly
  </h3>
  
  <p>The lock screen should only be shown when it is required by the head unit.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLockScreenConfigurationDisplayModeRequiredOnly</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">requiredOnly</span> <span class="o">=</span> <span class="mi">1</span></code></pre>

  
  
  
  <h3 id="section-SDLLockScreenConfigurationDisplayModeOptionalOrRequired">
      SDLLockScreenConfigurationDisplayModeOptionalOrRequired
  </h3>
  
  <p>The lock screen should be shown when required by the head unit or when the head unit says that its optional, but <em>not</em> in other cases, such as before the user has interacted with your app on the head unit.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLockScreenConfigurationDisplayModeOptionalOrRequired</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">optionalOrRequired</span> <span class="o">=</span> <span class="mi">2</span></code></pre>

  
  
  
  <h3 id="section-SDLLockScreenConfigurationDisplayModeAlways">
      SDLLockScreenConfigurationDisplayModeAlways
  </h3>
  
  <p>The lock screen should always be shown after connection.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLockScreenConfigurationDisplayModeAlways</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">always</span> <span class="o">=</span> <span class="mi">3</span></code></pre>

  
  
  
</section>