summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLPutFile.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLPutFile.html')
-rw-r--r--docs/Classes/SDLPutFile.html221
1 files changed, 198 insertions, 23 deletions
diff --git a/docs/Classes/SDLPutFile.html b/docs/Classes/SDLPutFile.html
index d4d7f2229..9350591e7 100644
--- a/docs/Classes/SDLPutFile.html
+++ b/docs/Classes/SDLPutFile.html
@@ -3,46 +3,67 @@
<h3>Section Contents</h3>
<ul>
+ <li><a href="#section--init">-init</a></li>
<li><a href="#section--initWithFileName:fileType:">-initWithFileName:fileType:</a></li>
<li><a href="#section--initWithFileName:fileType:persistentFile:">-initWithFileName:fileType:persistentFile:</a></li>
<li><a href="#section--initWithFileName:fileType:persistentFile:systemFile:offset:length:">-initWithFileName:fileType:persistentFile:systemFile:offset:length:</a></li>
+ <li><a href="#section--initWithFileName:fileType:persistentFile:systemFile:offset:length:crc:">-initWithFileName:fileType:persistentFile:systemFile:offset:length:crc:</a></li>
+ <li><a href="#section--initWithFileName:fileType:persistentFile:systemFile:offset:length:bulkData:">-initWithFileName:fileType:persistentFile:systemFile:offset:length:bulkData:</a></li>
<li><a href="#section-syncFileName">syncFileName</a></li>
<li><a href="#section-fileType">fileType</a></li>
<li><a href="#section-persistentFile">persistentFile</a></li>
<li><a href="#section-systemFile">systemFile</a></li>
<li><a href="#section-offset">offset</a></li>
<li><a href="#section-length">length</a></li>
+ <li><a href="#section-crc">crc</a></li>
</ul>
<h3>Overview</h3>
-<p>Used to push a binary data onto the SDL module from a mobile device, such as
- icons and album art</p>
+<p>Used to push a binary data onto the SDL module from a mobile device, such as icons and album art.</p>
<p>Since SmartDeviceLink 2.0</p>
<div class="aside aside-see">
<p class="aside-title">See</p>
- SDLDeleteFile
-
-</div>
-<div class="aside aside-see">
- <p class="aside-title">See</p>
- SDLListFiles
+ SDLDeleteFile, SDLListFiles
</div>
<section class="section task-group-section">
+ <h3 id="section--init">
+ -init
+ </h3>
+
+ <p>Init</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>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre>
+
+
+
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
+
<h3 id="section--initWithFileName:fileType:">
-initWithFileName:fileType:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init for creating a putfile with a name and file format.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFileName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span> <span class="nf">fileType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span><span class="p">;</span></code></pre>
+ <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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span>
+ <span class="nf">fileType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -50,17 +71,30 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>fileName</dt>
+ <dd><p>The file&rsquo;s name</p></dd>
+ <dt>fileType</dt>
+ <dd><p>The file&rsquo;s format</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
<h3 id="section--initWithFileName:fileType:persistentFile:">
-initWithFileName:fileType:persistentFile:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init for creating a putfile with a name, file format, and persistance.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFileName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span> <span class="nf">fileType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span> <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span><span class="p">;</span></code></pre>
+ <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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span>
+ <span class="nf">fileType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span>
+ <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -68,17 +102,35 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>fileName</dt>
+ <dd><p>The file&rsquo;s name</p></dd>
+ <dt>fileType</dt>
+ <dd><p>The file&rsquo;s format</p></dd>
+ <dt>persistentFile</dt>
+ <dd><p>Whether or not the image should persist between ignition cycles</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
<h3 id="section--initWithFileName:fileType:persistentFile:systemFile:offset:length:">
-initWithFileName:fileType:persistentFile:systemFile:offset:length:
</h3>
- <p>Undocumented</p>
+ <p>Convenience init for creating a putfile that is part of a multiple frame payload.</p>
<h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFileName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span> <span class="nf">fileType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span> <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span> <span class="nf">systemFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">systemFile</span> <span class="nf">offset</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">offset</span> <span class="nf">length</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">length</span><span class="p">;</span></code></pre>
+ <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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span>
+ <span class="nf">fileType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span>
+ <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span>
+ <span class="nf">systemFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">systemFile</span>
+ <span class="nf">offset</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">offset</span>
+ <span class="nf">length</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">length</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
@@ -86,14 +138,123 @@
+ <h4>Parameters</h4>
+ <dl>
+ <dt>fileName</dt>
+ <dd><p>The file&rsquo;s name</p></dd>
+ <dt>fileType</dt>
+ <dd><p>The file&rsquo;s format</p></dd>
+ <dt>persistentFile</dt>
+ <dd><p>Whether or not the image should persist between ignition cycles</p></dd>
+ <dt>systemFile</dt>
+ <dd><p>Whether or not the file is meant to be passed through Core to elsewhere on the system</p></dd>
+ <dt>offset</dt>
+ <dd><p>Offset in bytes for resuming partial data chunks</p></dd>
+ <dt>length</dt>
+ <dd><p>Length in bytes for resuming partial data chunks</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
+
+ <h3 id="section--initWithFileName:fileType:persistentFile:systemFile:offset:length:crc:">
+ -initWithFileName:fileType:persistentFile:systemFile:offset:length:crc:
+ </h3>
+
+ <p>Convenience init for creating a putfile that is part of a multiple frame payload.</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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span>
+ <span class="nf">fileType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span>
+ <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span>
+ <span class="nf">systemFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">systemFile</span>
+ <span class="nf">offset</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">offset</span>
+ <span class="nf">length</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">length</span>
+ <span class="nf">crc</span><span class="p">:(</span><span class="n">UInt64</span><span class="p">)</span><span class="nv">crc</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">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">,</span> <span class="nv">persistentFile</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">systemFile</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">offset</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">length</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">crc</span><span class="p">:</span> <span class="kt">UInt64</span><span class="p">)</span></code></pre>
+
+
+
+ <h4>Parameters</h4>
+ <dl>
+ <dt>fileName</dt>
+ <dd><p>The file&rsquo;s name</p></dd>
+ <dt>fileType</dt>
+ <dd><p>The file&rsquo;s format</p></dd>
+ <dt>persistentFile</dt>
+ <dd><p>Whether or not the image should persist between ignition cycles</p></dd>
+ <dt>systemFile</dt>
+ <dd><p>Whether or not the file is meant to be passed through Core to elsewhere on the system</p></dd>
+ <dt>offset</dt>
+ <dd><p>Offset in bytes for resuming partial data chunks</p></dd>
+ <dt>length</dt>
+ <dd><p>Length in bytes for resuming partial data chunks</p></dd>
+ <dt>crc</dt>
+ <dd><p>Checksum of the bulk data. Used by Core to check data integrity</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
+
+ <h3 id="section--initWithFileName:fileType:persistentFile:systemFile:offset:length:bulkData:">
+ -initWithFileName:fileType:persistentFile:systemFile:offset:length:bulkData:
+ </h3>
+
+ <p>Convenience init for creating a putfile that is part of a multiple frame payload. A CRC checksum is calculated for the bulk data.</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">initWithFileName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span>
+ <span class="nf">fileType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span>
+ <span class="nf">persistentFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistentFile</span>
+ <span class="nf">systemFile</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">systemFile</span>
+ <span class="nf">offset</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">offset</span>
+ <span class="nf">length</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">length</span>
+ <span class="nf">bulkData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">bulkData</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">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">,</span> <span class="nv">persistentFile</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">systemFile</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">offset</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">length</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">,</span> <span class="nv">bulkData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre>
+
+
+
+ <h4>Parameters</h4>
+ <dl>
+ <dt>fileName</dt>
+ <dd><p>The file&rsquo;s name</p></dd>
+ <dt>fileType</dt>
+ <dd><p>The file&rsquo;s format</p></dd>
+ <dt>persistentFile</dt>
+ <dd><p>Whether or not the image should persist between ignition cycles</p></dd>
+ <dt>systemFile</dt>
+ <dd><p>Whether or not the file is meant to be passed through Core to elsewhere on the system</p></dd>
+ <dt>offset</dt>
+ <dd><p>Offset in bytes for resuming partial data chunks</p></dd>
+ <dt>length</dt>
+ <dd><p>Length in bytes for resuming partial data chunks</p></dd>
+ <dt>bulkData</dt>
+ <dd><p>Data being sent in the putfile</p></dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>A SDLPutFile object</p>
+ </div>
<h3 id="section-syncFileName">
syncFileName
</h3>
- <p>A file reference name</p>
+ <p>File reference name</p>
-<p>Required, maxlength 255 characters</p>
+<p>Required, max length 255 characters</p>
@@ -131,13 +292,7 @@
persistentFile
</h3>
- <p>A value to indicates if the file is meant to persist between
- sessions / ignition cycles. If set to TRUE, then the system will aim to
- persist this file through session / cycles. While files with this
- designation will have priority over others, they are subject to deletion
- by the system at any time. In the event of automatic deletion by the
- system, the app will receive a rejection and have to resend the file. If
- omitted, the value will be set to false</p>
+ <p>A value to indicates if the file is meant to persist between sessions / ignition cycles. If set to TRUE, then the system will aim to persist this file through session / cycles. While files with this designation will have priority over others, they are subject to deletion by the system at any time. In the event of automatic deletion by the system, the app will receive a rejection and have to resend the file. If omitted, the value will be set to false.</p>
<p>Boolean, Optional, default = NO</p>
@@ -214,4 +369,24 @@
+ <h3 id="section-crc">
+ crc
+ </h3>
+
+ <p>Additional CRC32 checksum to protect data integrity up to 512 Mbits.</p>
+
+<p>Integer, Optional, 0 - 4,294,967,295</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight objective_c"><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">nonatomic</span><span class="p">,</span> <span class="n">nullable</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)SDLUInt">SDLUInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">crc</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">crc</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</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>