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
|
<h1>SDLScrollableMessage Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithMessage:">-initWithMessage:</a></li>
<li><a href="#section--initWithMessage:timeout:softButtons:cancelID:">-initWithMessage:timeout:softButtons:cancelID:</a></li>
<li><a href="#section-scrollableMessageBody">scrollableMessageBody</a></li>
<li><a href="#section-timeout">timeout</a></li>
<li><a href="#section-softButtons">softButtons</a></li>
<li><a href="#section-cancelID">cancelID</a></li>
</ul>
<h3>Overview</h3>
<p>Creates a full screen overlay containing a large block of formatted text that can be scrolled with buttons available.</p>
<p>If connecting to SDL Core v.6.0+, the scrollable message can be canceled programmatically using the <code>cancelID</code>. On older versions of SDL Core, the scrollable message will persist until the user has interacted with the scrollable message or the specified timeout has elapsed.</p>
<p>@since SDL 2.0</p>
<section class="section task-group-section">
<h3 id="section--initWithMessage:">
-initWithMessage:
</h3>
<p>Convenience init for creating a scrolling message with text.</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">initWithMessage</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>message</dt>
<dd><p>Body of text that can include newlines and tabs</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLScrollableMessage object</p>
</div>
<h3 id="section--initWithMessage:timeout:softButtons:cancelID:">
-initWithMessage:timeout:softButtons:cancelID:
</h3>
<p>Convenience init for creating a scrolling message with text and buttons.</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">initWithMessage</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span>
<span class="nf">timeout</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">timeout</span>
<span class="nf">softButtons</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</span>
<span class="nf">cancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">timeout</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">,</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span><span class="p">]?,</span> <span class="nv">cancelID</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>message</dt>
<dd><p>Body of text that can include newlines and tabs</p></dd>
<dt>timeout</dt>
<dd><p>Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout)</p></dd>
<dt>softButtons</dt>
<dd><p>Buttons for the displayed scrollable message</p></dd>
<dt>cancelID</dt>
<dd><p>An ID for this specific scrollable message to allow cancellation through the <code>CancelInteraction</code> RPC</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLScrollableMessage object</p>
</div>
<h3 id="section-scrollableMessageBody">
scrollableMessageBody
</h3>
<p>Body of text that can include newlines and tabs.</p>
<p>String, Required, Max length 500 chars</p>
<p>@since SDL 2.0</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">strong</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">scrollableMessageBody</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">scrollableMessageBody</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section-timeout">
timeout
</h3>
<p>App defined timeout. Indicates how long of a timeout from the last action (i.e. scrolling message resets timeout). If not set, a default value of 30 seconds is used by Core.</p>
<p>Integer, Optional, Min value: 1000, Max value: 65535, Default value: 30000</p>
<p>@since SDL 2.0</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">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">timeout</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></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-softButtons">
softButtons
</h3>
<p>Buttons for the displayed scrollable message. If omitted on supported displays, only the system defined “Close” SoftButton will be displayed.</p>
<p>Array of SDLSoftButton, Optional, Array size: 0-8</p>
<p>Since SDL 2.0</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">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></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-cancelID">
cancelID
</h3>
<p>An ID for this specific scrollable message to allow cancellation through the <code>CancelInteraction</code> RPC.</p>
<p>Integer, Optional</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
SDLCancelInteraction
@since SDL 6.0
</div>
<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">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">cancelID</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">cancelID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></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>
</section>
|
