blob: 494dc75ef5a0cab2152de99ee82fcb2ae0e06c8a (
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
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
|
<h1>SDLLockScreenViewController Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-appIcon">appIcon</a></li>
<li><a href="#section-vehicleIcon">vehicleIcon</a></li>
<li><a href="#section-backgroundColor">backgroundColor</a></li>
<li><a href="#section-lockedLabelText">lockedLabelText</a></li>
<li><a href="#section--addDismissGestureWithCallback:">-addDismissGestureWithCallback:</a></li>
<li><a href="#section--removeDismissGesture">-removeDismissGesture</a></li>
</ul>
<h3>Overview</h3>
<p>The view controller for the lockscreen.</p>
<section class="section task-group-section">
<h3 id="section-appIcon">
appIcon
</h3>
<p>The app’s icon. This will be set by the lock screen configuration.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</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="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-vehicleIcon">
vehicleIcon
</h3>
<p>The vehicle’s designated icon. This will be set by the lock screen manager when it is notified that a lock screen icon has been downloaded.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</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">vehicleIcon</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">vehicleIcon</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="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-backgroundColor">
backgroundColor
</h3>
<p>The designated background color set in the lock screen configuration, or the default SDL gray-blue.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</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="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-lockedLabelText">
lockedLabelText
</h3>
<p>The locked label string. This will be set by the lock screen manager to inform the user about the dismissible state.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">lockedLabelText</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">lockedLabelText</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section--addDismissGestureWithCallback:">
-addDismissGestureWithCallback:
</h3>
<p>Adds a swipe gesture to the lock screen view controller.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDismissGestureWithCallback</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLLockScreenViewController.h@T@SwipeGestureCallbackBlock">SwipeGestureCallbackBlock</a></span><span class="p">)</span><span class="nv">swipeGestureCallback</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addDismissGesture</span><span class="p">(</span><span class="n">callback</span> <span class="nv">swipeGestureCallback</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLLockScreenViewController.h@T@SwipeGestureCallbackBlock">SwipeGestureCallbackBlock</a></span><span class="p">)</span></code></pre>
<h3 id="section--removeDismissGesture">
-removeDismissGesture
</h3>
<p>Remove swipe gesture to the lock screen view controller.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">removeDismissGesture</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeDismissGesture</span><span class="p">()</span></code></pre>
</section>
|
