diff options
Diffstat (limited to 'docs/Classes/SDLSubtleAlert.html')
| -rw-r--r-- | docs/Classes/SDLSubtleAlert.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/docs/Classes/SDLSubtleAlert.html b/docs/Classes/SDLSubtleAlert.html new file mode 100644 index 000000000..fbe1613b1 --- /dev/null +++ b/docs/Classes/SDLSubtleAlert.html @@ -0,0 +1,201 @@ +<h1>SDLSubtleAlert Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithAlertText1:alertText2:alertIcon:ttsChunks:duration:softButtons:cancelID:">-initWithAlertText1:alertText2:alertIcon:ttsChunks:duration:softButtons:cancelID:</a></li> + <li><a href="#section-alertText1">alertText1</a></li> + <li><a href="#section-alertText2">alertText2</a></li> + <li><a href="#section-alertIcon">alertIcon</a></li> + <li><a href="#section-ttsChunks">ttsChunks</a></li> + <li><a href="#section-duration">duration</a></li> + <li><a href="#section-softButtons">softButtons</a></li> + <li><a href="#section-cancelID">cancelID</a></li> +</ul> + +<h3>Overview</h3> + +<p>Shows an alert which typically consists of text-to-speech message and text on the display. At least either alertText1, alertText2 or TTSChunks need to be provided.</p> + +<p>@since SDL 7.0.0</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithAlertText1:alertText2:alertIcon:ttsChunks:duration:softButtons:cancelID:"> + -initWithAlertText1:alertText2:alertIcon:ttsChunks:duration:softButtons:cancelID: + </h3> + + + + + <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">initWithAlertText1</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText1</span> + <span class="nf">alertText2</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">alertText2</span> + <span class="nf">alertIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">alertIcon</span> + <span class="nf">ttsChunks</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/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span> + <span class="nf">duration</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">duration</span> + <span class="nf">softButtons</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">nullable</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="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">alertText1</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alertText2</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</span> <span class="nv">alertIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</a></span><span class="p">?,</span> <span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?,</span> <span class="nv">duration</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)SDLUInt">SDLUInt</a></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="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></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>alertText1</dt> + <dd><p>- alertText1</p></dd> + <dt>alertText2</dt> + <dd><p>- alertText2</p></dd> + <dt>alertIcon</dt> + <dd><p>- alertIcon</p></dd> + <dt>ttsChunks</dt> + <dd><p>- ttsChunks</p></dd> + <dt>duration</dt> + <dd><p>- duration</p></dd> + <dt>softButtons</dt> + <dd><p>- softButtons</p></dd> + <dt>cancelID</dt> + <dd><p>- cancelID</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLSubtleAlert object</p> + </div> + + <h3 id="section-alertText1"> + alertText1 + </h3> + + <p>The first line of the alert text field +{“default_value”: null, “max_length”: 500, “min_length”: 1}</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">NSString</span> <span class="o">*</span><span class="n">alertText1</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertText1</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-alertText2"> + alertText2 + </h3> + + <p>The second line of the alert text field +{“default_value”: null, “max_length”: 500, “min_length”: 1}</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">NSString</span> <span class="o">*</span><span class="n">alertText2</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertText2</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-alertIcon"> + alertIcon + </h3> + + <p>Image to be displayed for the corresponding alert. See Image. If omitted on supported displays, no (or the default if applicable) icon should be displayed.</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"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">alertIcon</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">alertIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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-ttsChunks"> + ttsChunks + </h3> + + <p>An array of text chunks of type TTSChunk. See TTSChunk. The array must have at least one item. +{“default_value”: null, “max_size”: 100, “min_size”: 1}</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/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">ttsChunks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</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-duration"> + duration + </h3> + + <p>Timeout in milliseconds. Typical timeouts are 3-5 seconds. If omitted, timeout is set to 5s. +{“default_value”: 5000, “max_value”: 10000, “min_value”: 3000}</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)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">duration</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">duration</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)SDLUInt">SDLUInt</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>App defined SoftButtons. If omitted on supported displays, the displayed alert shall not have any SoftButtons. +{“default_value”: null, “max_size”: 2, “min_size”: 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 alert to allow cancellation through the <code>CancelInteraction</code> RPC. +{“default_value”: null, “max_value”: null, “min_value”: null}</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">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> |