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
|
<h1>SDLGetFileResponse Class Reference</h1>
<h3>Section Contents</h3>
<ul>
<li><a href="#section--initWithOffset:length:fileType:crc:">-initWithOffset:length:fileType:crc:</a></li>
<li><a href="#section-offset">offset</a></li>
<li><a href="#section-length">length</a></li>
<li><a href="#section-fileType">fileType</a></li>
<li><a href="#section-crc">crc</a></li>
</ul>
<h3>Overview</h3>
<p>Response to GetFiles</p>
<p>@since RPC 5.1</p>
<section class="section task-group-section">
<h3 id="section--initWithOffset:length:fileType:crc:">
-initWithOffset:length:fileType:crc:
</h3>
<p>Convenience init for all parameters.</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">initWithOffset</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">fileType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span>
<span class="nf">crc</span><span class="p">:(</span><span class="n">UInt32</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">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">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">?,</span> <span class="nv">crc</span><span class="p">:</span> <span class="kt">UInt32</span><span class="p">)</span></code></pre>
<h4>Parameters</h4>
<dl>
<dt>offset</dt>
<dd><p>Optional offset in bytes for resuming partial data chunks</p></dd>
<dt>length</dt>
<dd><p>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded</p></dd>
<dt>fileType</dt>
<dd><p>File type that is being sent in response</p></dd>
<dt>crc</dt>
<dd><p>Additional CRC32 checksum to protect data integrity up to 512 Mbits</p></dd>
</dl>
<div>
<h4>Return Value</h4>
<p>A SDLGetFileResponse object</p>
</div>
<h3 id="section-offset">
offset
</h3>
<p>Optional offset in bytes for resuming partial data chunks.</p>
<p>Integer, Optional, minvalue=“0” maxvalue=“2000000000”</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"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">offset</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</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>
<h3 id="section-length">
length
</h3>
<p>Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded.</p>
<p>Integer, Optional, minvalue=“0” maxvalue=“2000000000”</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"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">length</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&</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>
<h3 id="section-fileType">
fileType
</h3>
<p>File type that is being sent in response.</p>
<p>SDLFileType, Optional</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"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span></code></pre>
<h4>Swift</h4>
<pre class="highlight swift"><code><span class="k">var</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</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>
<h3 id="section-crc">
crc
</h3>
<p>Additional CRC32 checksum to protect data integrity up to 512 Mbits.</p>
<p>Integer, Optional, minvalue=“0” maxvalue=“4294967295”</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"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></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">&</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>
|
