summaryrefslogtreecommitdiff
path: root/docs/Type Definitions.html
blob: c73b76f52ee7b284856544ab0e45bca91b4dea9b (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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
<h1>Type Definitions  Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-SDLFileName">SDLFileName</a></li>
  <li><a href="#section-SDLFileManagerStartupCompletionHandler">SDLFileManagerStartupCompletionHandler</a></li>
  <li><a href="#section-SDLFileManagerUploadCompletionHandler">SDLFileManagerUploadCompletionHandler</a></li>
  <li><a href="#section-SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></li>
  <li><a href="#section-SDLFileManagerListFilesCompletionHandler">SDLFileManagerListFilesCompletionHandler</a></li>
  <li><a href="#section-SDLManagerReadyBlock">SDLManagerReadyBlock</a></li>
  <li><a href="#section-SDLNotificationName">SDLNotificationName</a></li>
  <li><a href="#section-SDLNotificationUserInfoKey">SDLNotificationUserInfoKey</a></li>
  <li><a href="#section-SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></li>
  <li><a href="#section-SDLResponseHandler">SDLResponseHandler</a></li>
  <li><a href="#section-SDLPermissionRPCName">SDLPermissionRPCName</a></li>
  <li><a href="#section-SDLPermissionObserverIdentifier">SDLPermissionObserverIdentifier</a></li>
  <li><a href="#section-SDLPermissionsChangedHandler">SDLPermissionsChangedHandler</a></li>
  <li><a href="#section-SDLStreamingStartBlock">SDLStreamingStartBlock</a></li>
  <li><a href="#section-SDLStreamingEncryptionStartBlock">SDLStreamingEncryptionStartBlock</a></li>
</ul>

<h3>Overview</h3>

<p>The following type definitions are available globally.</p>


<section class="section task-group-section">
  <h3 id="section-SDLFileName">
      SDLFileName
  </h3>
  
  <p>Undocumented</p>

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

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

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

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

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

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

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

  
  
  
  
  
  <h3 id="section-SDLRPCNotificationHandler">
      SDLRPCNotificationHandler
  </h3>
  
  <p>A handler used on certain RPCs, primarily buttons or commands, when an event occurs.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLRPCNotificationHandler</span><span class="p">)(</span><span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCNotification.html">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">typealias</span> <span class="kt">SDLRPCNotificationHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCNotification.html">SDLRPCNotification</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>notification</dt>
      <dd><p>The RPC Notification that was fired.</p>
</dd>
  </dl>
  
  <h3 id="section-SDLResponseHandler">
      SDLResponseHandler
  </h3>
  
  <p>A handler used on all RPC requests which fires when the response is received.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLResponseHandler</span><span class="p">)(</span><span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span>
                                   <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">,</span>
                                   <span class="n">NSError</span> <span class="o">*</span><span class="n">_Nullable</span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">typealias</span> <span class="kt">SDLResponseHandler</span> <span class="o">=</span> <span class="p">(</span><span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">?,</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span><span class="p">?,</span> <span class="kt">Error</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>request</dt>
      <dd><p>The request which was sent.</p>
</dd>
      <dt>response</dt>
      <dd><p>The response which was received.</p>
</dd>
      <dt>error</dt>
      <dd><p>If sending the request encountered an error, this parameter will not be nil.</p>
</dd>
  </dl>
  
  <h3 id="section-SDLPermissionRPCName">
      SDLPermissionRPCName
  </h3>
  
  <p>Undocumented</p>

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

  
  
  
  
  
  <h3 id="section-SDLPermissionsChangedHandler">
      SDLPermissionsChangedHandler
  </h3>
  
  <p>The PermissionObserver is a block that is passed in to some methods that will be stored and called when specified permissions change.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight"><code><span class="k">typedef</span> <span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="n">SDLPermissionsChangedHandler</span><span class="p">)(</span>
    <span class="n">NSDictionary</span><span class="o">&lt;</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="p">,</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span><span class="p">,</span>
    <span class="n"><a href="Enums/SDLPermissionGroupStatus.html">SDLPermissionGroupStatus</a></span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight"><code><span class="kd">typealias</span> <span class="kt">SDLPermissionsChangedHandler</span> <span class="o">=</span> <span class="p">([</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">NSNumber</span><span class="p">],</span> <span class="kt"><a href="Enums/SDLPermissionGroupStatus.html">SDLPermissionGroupStatus</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>change</dt>
      <dd><p>A dictionary of permission changes containing 
<key
(String): RPC Name, object(BOOL): YES if the RPC is allowed, NO if it is not allowed></p>
</dd>
      <dt>status</dt>
      <dd><p>The change made to all of the RPCs in the changedDict. Allowed, if all RPCs are now allowed, Disallowed if all RPCs are now disallowed, or Mixed if some are allowed, and some are disallowed</p>
</dd>
  </dl>
  
  <h3 id="section-SDLStreamingStartBlock">
      SDLStreamingStartBlock
  </h3>
  
  <p>Undocumented</p>

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

  
  
  
  
  
</section>