summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLSetGlobalProperties.html
blob: 837539ee5e7639bf79a84c495ee57c5a81bf81a6 (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
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
<h1>SDLSetGlobalProperties Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--init">-init</a></li>
  <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li>
  <li><a href="#section-helpPrompt">helpPrompt</a></li>
  <li><a href="#section-timeoutPrompt">timeoutPrompt</a></li>
  <li><a href="#section-vrHelpTitle">vrHelpTitle</a></li>
  <li><a href="#section-vrHelp">vrHelp</a></li>
  <li><a href="#section-menuTitle">menuTitle</a></li>
  <li><a href="#section-menuIcon">menuIcon</a></li>
  <li><a href="#section-keyboardProperties">keyboardProperties</a></li>
</ul>

<h3>Overview</h3>

<p>Sets value(s) for the specified global property(ies)
 <p>
 Function Group: Base <p>
 <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b>
 </p></p>

<p>Since SmartDeviceLink 1.0
 See SDLResetGlobalProperties</p>


<section class="section task-group-section">
  <h3 id="section--init">
      -init
  </h3>
  
  <p>@abstract Constructs a new SDLSetGlobalProperties object</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><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="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre>

  
  
  
  <h3 id="section--initWithDictionary:">
      -initWithDictionary:
  </h3>
  
  <p>@abstract Constructs a new SDLSetGlobalProperties object indicated by the NSMutableDictionary
parameter
- parameter: dict The dictionary to use</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>dict</dt>
      <dd><p>The dictionary to use</p>
</dd>
  </dl>
  
  <h3 id="section-helpPrompt">
      helpPrompt
  </h3>
  
  <p>@abstract Sets a Vector<TTSChunk> for Help Prompt that Array of one or more
TTSChunk elements specifying the help prompt used in an interaction
started by PTT
@discussion helpPrompt
           a Vector<TTSChunk> of one or more TTSChunk elements
           <p>
           <b>Notes: </b>
           <ul>
           <li>Array must have at least one element</li>
           <li>Only optional it timeoutPrompt has been specified</li>
           </ul></p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">helpPrompt</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">helpPrompt</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-timeoutPrompt">
      timeoutPrompt
  </h3>
  
  <p>@abstract A Vector<TTSChunk> for Timeout Prompt representing Array of one or
 more TTSChunk elements specifying the help prompt used in an interaction
 started by PTT</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">timeoutPrompt</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeoutPrompt</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-vrHelpTitle">
      vrHelpTitle
  </h3>
  
  <p>@abstract Sets a voice recognition Help Title</p>

<p>@discussion A String value representing a voice recognition Help Title
            <p>
            <b>Notes: </b><br/>
            <ul>
            <li>If omitted on supported displays, the default SDL help
            title will be used</li>
            <li>If omitted and one or more vrHelp items are provided, the
            request will be rejected.</li>
            <li>String Maxlength = 500</li>
            </ul>
 @since SmartDeviceLink 2.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">vrHelpTitle</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelpTitle</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-vrHelp">
      vrHelp
  </h3>
  
  <p>@abstract Sets the items listed in the VR help screen used in an interaction
 started by PTT</p>

<p>@discussion A Vector value representing items listed in the VR help screen
            used in an interaction started by PTT
            <p>
            <b>Notes: </b><br/>
            <ul>
            <li>If omitted on supported displays, the default SmartDeviceLink VR
            help / What Can I Say? screen will be used</li>
            <li>If the list of VR Help Items contains nonsequential
            positions (e.g. [1,2,4]), the RPC will be rejected</li>
            <li>If omitted and a vrHelpTitle is provided, the request
            will be rejected</li>
            <li>Array Minsize: = 1</li>
            <li>Array Maxsize = 100</li>
            </ul>
 @since SmartDeviceLink 2.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">vrHelp</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelp</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-menuTitle">
      menuTitle
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre>

  
  
  
  
  <h3 id="section-menuIcon">
      menuIcon
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre>

  
  
  
  
  <h3 id="section-keyboardProperties">
      keyboardProperties
  </h3>
  
  <p>Undocumented</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre>

  
  
  
  
</section>