diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
---|---|---|
committer | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
commit | 4233b570952751945a3f066f35595fbcaec2b0ae (patch) | |
tree | 7888256d1be523dfcb3f4343c59b64b1b516a644 /docs/Classes/SDLFileManager.html | |
parent | 43f6367aa18724143032f3624887b0f867c5cc47 (diff) | |
download | sdl_ios-release/5.0.0.tar.gz |
Update for 5.0.0 releaserelease/5.0.0
Diffstat (limited to 'docs/Classes/SDLFileManager.html')
-rw-r--r-- | docs/Classes/SDLFileManager.html | 120 |
1 files changed, 101 insertions, 19 deletions
diff --git a/docs/Classes/SDLFileManager.html b/docs/Classes/SDLFileManager.html index 6d611a647..ef936c5e9 100644 --- a/docs/Classes/SDLFileManager.html +++ b/docs/Classes/SDLFileManager.html @@ -13,7 +13,10 @@ <li><a href="#section--startWithCompletionHandler:">-startWithCompletionHandler:</a></li> <li><a href="#section--stop">-stop</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-+temporaryFileDirectory">+temporaryFileDirectory</a></li> </ul> @@ -33,7 +36,7 @@ <h4>Objective-C</h4> <pre class="highlight"><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:SDLFileManager.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> + <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> @@ -132,7 +135,6 @@ <div> <h4>Return Value</h4> <p>nil</p> - </div> <h3 id="section--initWithConnectionManager:"> @@ -153,13 +155,11 @@ <h4>Parameters</h4> <dl> <dt>manager</dt> - <dd><p>A connection manager to use to forward on RPCs</p> -</dd> + <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--startWithCompletionHandler:"> @@ -183,8 +183,7 @@ <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> + <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"> @@ -214,24 +213,50 @@ <h4>Objective-C</h4> - <pre class="highlight"><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:SDLFileManager.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <pre class="highlight"><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"><code><span class="kd">func</span> <span class="nf">deleteRemoteFile</span><span class="p">(</span><span class="n">withName</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> + <pre class="highlight"><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> + <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> + <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"><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"><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:"> @@ -249,18 +274,76 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">uploadFile</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="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> + <pre class="highlight"><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> + <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> + <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"><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"><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"><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"><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-+temporaryFileDirectory"> @@ -285,7 +368,6 @@ <div> <h4>Return Value</h4> <p>An NSURL pointing to the location on disk where SDL’s temporary files are stored.</p> - </div> </section> |