summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLAlertManeuver.html
blob: d9c9ad70e0afcadbe300ed2e664a2b03d0a8a3b6 (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
130
131
132
<h1>SDLAlertManeuver Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithTTS:softButtons:">-initWithTTS:softButtons:</a></li>
  <li><a href="#section--initWithTTSChunks:softButtons:">-initWithTTSChunks:softButtons:</a></li>
  <li><a href="#section-ttsChunks">ttsChunks</a></li>
  <li><a href="#section-softButtons">softButtons</a></li>
</ul>

<h3>Overview</h3>

<p>Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display&rsquo;s base screen.</p>

<p>@since SmartDeviceLink 1.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithTTS:softButtons:">
      -initWithTTS:softButtons:
  </h3>
  
  <p>Convenience init to create an alert maneuver with required parameters</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">initWithTTS</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">ttsText</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">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</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="n">tts</span> <span class="nv">ttsText</span><span class="p">:</span> <span class="kt">String</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></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>ttsText</dt>
      <dd><p>The text to speak</p></dd>
      <dt>softButtons</dt>
      <dd><p>An array of soft buttons</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLAlertManeuver object</p>
  </div>
  
  <h3 id="section--initWithTTSChunks:softButtons:">
      -initWithTTSChunks:softButtons:
  </h3>
  
  <p>Convenience init to create an alert maneuver with all parameters</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">initWithTTSChunks</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsChunks</span>
          <span class="nf">softButtons</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</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">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">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></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>ttsChunks</dt>
      <dd><p>An array of text chunks</p></dd>
      <dt>softButtons</dt>
      <dd><p>An array of soft buttons</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>An SDLAlertManeuver object</p>
  </div>
  
  <h3 id="section-ttsChunks">
      ttsChunks
  </h3>
  
  <p>An array of text chunks.</p>

<p>Optional, Array of SDLTTSChunk, Array length 1 - 100</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLTTSChunk

</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</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-softButtons">
      softButtons
  </h3>
  
  <p>An array of soft buttons. If omitted on supported displays, only the system defined &ldquo;Close&rdquo; SoftButton shall be displayed.</p>

<p>Optional, Array of SDLSoftButton, Array length 0 - 3</p>
<div class="aside aside-see">
    <p class="aside-title">See</p>
    SDLSoftButton

</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*&gt;</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>

  
  
  
</section>