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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
|
<h1>SDLFileManager Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section-remoteFileNames">remoteFileNames</a></li>
<li><a href="#section-bytesAvailable">bytesAvailable</a></li>
<li><a href="#section-currentState">currentState</a></li>
<li><a href="#section-pendingTransactions">pendingTransactions</a></li>
<li><a href="#section-suspended">suspended</a></li>
<li><a href="#section--init">-init</a></li>
<li><a href="#section--initWithConnectionManager:">-initWithConnectionManager:</a></li>
<li><a href="#section--initWithConnectionManager:configuration:">-initWithConnectionManager:configuration:</a></li>
<li><a href="#section--startWithCompletionHandler:">-startWithCompletionHandler:</a></li>
<li><a href="#section--stop">-stop</a></li>
<li><a href="#section--hasUploadedFile:">-hasUploadedFile:</a></li>
<li><a href="#section--deleteRemoteFileWithName:completionHandler:">-deleteRemoteFileWithName:completionHandler:</a></li>
<li><a href="#section--deleteRemoteFilesWithNames:completionHandler:">-deleteRemoteFilesWithNames:completionHandler:</a></li>
<li><a href="#section--uploadFile:completionHandler:">-uploadFile:completionHandler:</a></li>
<li><a href="#section--uploadFiles:progressHandler:completionHandler:">-uploadFiles:progressHandler:completionHandler:</a></li>
<li><a href="#section--uploadFiles:completionHandler:">-uploadFiles:completionHandler:</a></li>
<li><a href="#section--uploadArtwork:completionHandler:">-uploadArtwork:completionHandler:</a></li>
<li><a href="#section--uploadArtworks:completionHandler:">-uploadArtworks:completionHandler:</a></li>
<li><a href="#section--uploadArtworks:progressHandler:completionHandler:">-uploadArtworks:progressHandler:completionHandler:</a></li>
<li><a href="#section-+temporaryFileDirectory">+temporaryFileDirectory</a></li>
</ul>
<h3>Overview</h3>
<p>The SDLFileManager is an RPC manager for the remote file system. After it starts, it will attempt to communicate with the remote file system to get the names of all files. Deleting and Uploading will them queue these changes as transactions. If a delete succeeds, the local list of remote files will remove that file name, and likewise, if an upload succeeds, the local list of remote files will now include that file name.</p>
<section class="section task-group-section">
<h3 id="section-remoteFileNames">
remoteFileNames
</h3>
<p>A set of all names of files known on the remote head unit. Known files can be used or deleted on the remote system.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
<span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">remoteFileNames</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">remoteFileNames</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt">String</span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-bytesAvailable">
bytesAvailable
</h3>
<p>The number of bytes still available for files for this app.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">bytesAvailable</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">bytesAvailable</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-currentState">
currentState
</h3>
<p>The state of the file manager.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">currentState</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">currentState</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-pendingTransactions">
pendingTransactions
</h3>
<p>The currently pending transactions (Upload, Delete, and List Files) in the file manager</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span>
<span class="n">NSArray</span><span class="o"><</span><span class="n">__kindof</span> <span class="n">NSOperation</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">pendingTransactions</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">pendingTransactions</span><span class="p">:</span> <span class="p">[</span><span class="kt">Operation</span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
<h3 id="section-suspended">
suspended
</h3>
<p>Whether or not the file manager is suspended. If suspended, the file manager can continue to queue uploads and deletes, but will not actually perform any of those until it is no longer suspended. This can be used for throttling down the file manager if other, important operations are taking place over the accessory connection.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">suspended</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">suspended</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>
<h3 id="section--init">
-init
</h3>
<p>Initialize the class…or not, since this method is unavailable. Dependencies must be injected using initWithConnectionManager:</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="n">init</span><span class="p">;</span></code></pre>
<div>
<h4>Return Value</h4>
<p>nil</p>
</div>
<h3 id="section--initWithConnectionManager:">
-initWithConnectionManager:
</h3>
<p>Creates a new file manager with a specified connection manager</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">initWithConnectionManager</span><span class="p">:</span>
<span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">manager</span><span class="p">;</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>manager</dt>
<dd><p>A connection manager to use to forward on RPCs</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>An instance of SDLFileManager</p>
</div>
<h3 id="section--initWithConnectionManager:configuration:">
-initWithConnectionManager:configuration:
</h3>
<p>Creates a new file manager with a specified connection manager and configuration</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">initWithConnectionManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">manager</span>
<span class="nf">configuration</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">configuration</span><span class="p">;</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>manager</dt>
<dd><p>A connection manager to use to forward on RPCs</p></dd>
<dt>configuration</dt>
<dd><p>A configuration for this file manager session</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>An instance of SDLFileManager</p>
</div>
<h3 id="section--startWithCompletionHandler:">
-startWithCompletionHandler:
</h3>
<p>The manager stars up and attempts to fetch its initial list and transfer initial files.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithCompletionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler">SDLFileManagerStartupCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManager.h@T@SDLFileManagerStartupCompletionHandler">SDLFileManagerStartupCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>completionHandler</dt>
<dd><p>The handler called when the manager is set up or failed to set up with an error. Use weak self when accessing self from the completion handler.</p></dd>
</dl>
<h3 id="section--stop">
-stop
</h3>
<p>Cancels all file manager operations and deletes all associated data.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre>
<h3 id="section--hasUploadedFile:">
-hasUploadedFile:
</h3>
<p>Check if the remote system contains a file</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">hasUploadedFile</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">hasUploadedFile</span><span class="p">(</span><span class="n">_</span> <span class="nv">file</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>file</dt>
<dd><p>The file to check</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>Whether or not the remote system has the file</p>
</div>
<h3 id="section--deleteRemoteFileWithName:completionHandler:">
-deleteRemoteFileWithName:completionHandler:
</h3>
<p>Delete a file stored on the remote system</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">deleteRemoteFileWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></span><span class="p">)</span><span class="nv">completion</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">delete</span><span class="p">(</span><span class="n">fileName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>name</dt>
<dd><p>The name of the remote file. It should be a name currently stored in remoteFileNames</p></dd>
<dt>completion</dt>
<dd><p>An optional completion handler that sends an error should one occur.</p></dd>
</dl>
<h3 id="section--deleteRemoteFilesWithNames:completionHandler:">
-deleteRemoteFilesWithNames:completionHandler:
</h3>
<p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">deleteRemoteFilesWithNames</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">names</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler">SDLFileManagerMultiDeleteCompletionHandler</a></span><span class="p">)</span>
<span class="n">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">delete</span><span class="p">(</span><span class="n">fileNames</span> <span class="nv">names</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">],</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler">SDLFileManagerMultiDeleteCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>names</dt>
<dd><p>The names of the files to be deleted</p></dd>
<dt>completionHandler</dt>
<dd><p>an optional SDLFileManagerMultiDeleteCompletionHandler</p></dd>
</dl>
<h3 id="section--uploadFile:completionHandler:">
-uploadFile:completionHandler:
</h3>
<p>Upload a file to the remote file system. If a file with the [SDLFile name] already exists, this will overwrite that file. If you do not want that to happen, check remoteFileNames before uploading, or change allowOverwrite to NO.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadFile</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler">SDLFileManagerUploadCompletionHandler</a></span><span class="p">)</span><span class="nv">completion</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">file</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler">SDLFileManagerUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>file</dt>
<dd><p>An SDLFile that contains metadata about the file to be sent</p></dd>
<dt>completion</dt>
<dd><p>An optional completion handler that sends an error should one occur.</p></dd>
</dl>
<h3 id="section--uploadFiles:progressHandler:completionHandler:">
-uploadFiles:progressHandler:completionHandler:
</h3>
<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>
<p>The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occured during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadFiles</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span>
<span class="nf">progressHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler">SDLFileManagerMultiUploadProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">files</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler">SDLFileManagerMultiUploadProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>files</dt>
<dd><p>An array of SDLFiles to be sent</p></dd>
<dt>progressHandler</dt>
<dd><p>an optional SDLFileManagerMultiUploadProgressHandler</p></dd>
<dt>completionHandler</dt>
<dd><p>an optional SDLFileManagerMultiUploadCompletionHandler</p></dd>
</dl>
<h3 id="section--uploadFiles:completionHandler:">
-uploadFiles:completionHandler:
</h3>
<p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadFiles</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">files</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">],</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>files</dt>
<dd><p>An array of SDLFiles to be sent</p></dd>
<dt>completionHandler</dt>
<dd><p>An optional SDLFileManagerMultiUploadCompletionHandler</p></dd>
</dl>
<h3 id="section--uploadArtwork:completionHandler:">
-uploadArtwork:completionHandler:
</h3>
<p>Uploads an artwork file to the remote file system and returns the name of the uploaded artwork once completed. If an artwork with the same name is already on the remote system, the artwork is not uploaded and the artwork name is simply returned.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadArtwork</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">artwork</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadArtworkCompletionHandler">SDLFileManagerUploadArtworkCompletionHandler</a></span><span class="p">)</span><span class="nv">completion</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">artwork</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadArtworkCompletionHandler">SDLFileManagerUploadArtworkCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>artwork</dt>
<dd><p>A SDLArwork containing an image to be sent</p></dd>
<dt>completion</dt>
<dd><p>An optional completion handler that returns the name of the uploaded artwork. It also returns an error if the upload fails.</p></dd>
</dl>
<h3 id="section--uploadArtworks:completionHandler:">
-uploadArtworks:completionHandler:
</h3>
<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadArtworks</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">artworks</span>
<span class="nf">completionHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler">SDLFileManagerMultiUploadArtworkCompletionHandler</a></span><span class="p">)</span><span class="nv">completion</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">artworks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">],</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler">SDLFileManagerMultiUploadArtworkCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>artworks</dt>
<dd><p>An array of SDLArtworks to be sent</p></dd>
<dt>completion</dt>
<dd><p>An optional SDLFileManagerMultiUploadArtworkCompletionHandler</p></dd>
</dl>
<h3 id="section--uploadArtworks:progressHandler:completionHandler:">
-uploadArtworks:progressHandler:completionHandler:
</h3>
<p>Uploads an array of artworks to the remote file system. The artworks will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p>
<p>The optional progress handler can be used to keep track of the upload progress. After each artwork upload, the progress handler returns the artwork name, the upload percentage and an error, if one occured during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.</p>
<h4>Objective-C</h4>
<pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">uploadArtworks</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">artworks</span>
<span class="nf">progressHandler</span><span class="p">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkProgressHandler">SDLFileManagerMultiUploadArtworkProgressHandler</a></span><span class="p">)</span>
<span class="n">progressHandler</span>
<span class="n">completionHandler</span><span class="o">:</span>
<span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler">SDLFileManagerMultiUploadArtworkCompletionHandler</a></span><span class="p">)</span><span class="n">completion</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">artworks</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkProgressHandler">SDLFileManagerMultiUploadArtworkProgressHandler</a></span><span class="p">?,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadArtworkCompletionHandler">SDLFileManagerMultiUploadArtworkCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>artworks</dt>
<dd><p>An array of SDLArtworks to be sent</p></dd>
<dt>progressHandler</dt>
<dd><p>An optional SDLFileManagerMultiUploadArtworkProgressHandler</p></dd>
<dt>completion</dt>
<dd><p>An optional SDLFileManagerMultiUploadArtworkCompletionHandler</p></dd>
</dl>
<h3 id="section-+temporaryFileDirectory">
+temporaryFileDirectory
</h3>
<p>A URL to the directory where temporary files are stored. When an SDLFile is created with NSData, it writes to a temporary file until the file manager finishes uploading it.</p>
<p>The SDL library manages the creation and deletion of these files and you should not have to touch this directory at all.</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">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="n">temporaryFileDirectory</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">temporaryFileDirectory</span><span class="p">()</span> <span class="o">-></span> <span class="kt">URL</span></code></pre>
<div>
<h4>Return Value</h4>
<p>An NSURL pointing to the location on disk where SDL’s temporary files are stored.</p>
</div>
</section>
|
