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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
<h1>SDLLockScreenConfiguration Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-showInOptionalState">showInOptionalState</a></li>
<li><a href="#section-enableAutomaticLockScreen">enableAutomaticLockScreen</a></li>
<li><a href="#section-backgroundColor">backgroundColor</a></li>
<li><a href="#section-appIcon">appIcon</a></li>
<li><a href="#section-customViewController">customViewController</a></li>
<li><a href="#section--init">-init</a></li>
<li><a href="#section-+disabledConfiguration">+disabledConfiguration</a></li>
<li><a href="#section-+enabledConfiguration">+enabledConfiguration</a></li>
<li><a href="#section-+enabledConfigurationWithAppIcon:backgroundColor:">+enabledConfigurationWithAppIcon:backgroundColor:</a></li>
<li><a href="#section-+enabledConfigurationWithViewController:">+enabledConfigurationWithViewController:</a></li>
</ul>
<h3>Overview</h3>
<p>Undocumented</p>
<section class="section task-group-section">
<h3 id="section-showInOptionalState">
showInOptionalState
</h3>
<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>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">showInOptionalState</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">showInOptionalState</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-enableAutomaticLockScreen">
enableAutomaticLockScreen
</h3>
<p>If YES, the lock screen should be managed by SDL and automatically engage when necessary. If NO, then the lock screen will never be engaged.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">enableAutomaticLockScreen</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">enableAutomaticLockScreen</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-backgroundColor">
backgroundColor
</h3>
<p>The background color of the lock screen. This could be a branding color, or leave at the default for a dark blue-gray.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">backgroundColor</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-appIcon">
appIcon
</h3>
<p>Your app icon as it will appear on the lock screen.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">appIcon</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">appIcon</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-customViewController">
customViewController
</h3>
<p>A custom view controller that the lock screen will manage the presentation of.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span>
<span class="n">UIViewController</span> <span class="o">*</span><span class="n">customViewController</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">customViewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section--init">
-init
</h3>
<p>Undocumented</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span></code></pre>
<h3 id="section-+disabledConfiguration">
+disabledConfiguration
</h3>
<p>Use this configuration if you wish to manage a lock screen yourself. This may be useful if the automatic presentation feature of SDLLockScreenManager is failing for some reason.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">disabledConfiguration</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">disabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<div>
<h4>Return Value</h4>
<p>The configuration</p>
</div>
<h3 id="section-+enabledConfiguration">
+enabledConfiguration
</h3>
<p>Use this configuration for the basic default lock screen. A custom app icon will not be used.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">enabledConfiguration</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<div>
<h4>Return Value</h4>
<p>The configuration</p>
</div>
<h3 id="section-+enabledConfigurationWithAppIcon:backgroundColor:">
+enabledConfigurationWithAppIcon:backgroundColor:
</h3>
<p>Use this configuration to provide a custom lock screen icon and a custom background color, or nil if you wish to use the default background color. This will use the default lock screen layout.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
<span class="nf">enabledConfigurationWithAppIcon</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenAppIcon</span>
<span class="nf">backgroundColor</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenBackgroundColor</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">withAppIcon</span> <span class="nv">lockScreenAppIcon</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor">backgroundColor</a></span> <span class="nv">lockScreenBackgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>lockScreenAppIcon</dt>
<dd><p>The app icon to be shown on the lock screen</p></dd>
<dt>lockScreenBackgroundColor</dt>
<dd><p>The color of the lock screen background</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The configuration</p>
</div>
<h3 id="section-+enabledConfigurationWithViewController:">
+enabledConfigurationWithViewController:
</h3>
<p>Use this configuration if you wish to provide your own view controller for the lock screen. This view controller’s presentation and dismissal will still be managed by the lock screen manager. Note that you may subclass SDLLockScreenViewController and pass it here to continue to have the vehicle icon set to your view controller by the manager.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">enabledConfigurationWithViewController</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">viewController</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">with</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>viewController</dt>
<dd><p>The view controller to be managed</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>The configuration</p>
</div>
</section>
|
