Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update: update api document #12

Merged
merged 1 commit into from
Dec 12, 2023
Merged

update: update api document #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/Classes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">AliyunpanSDK 0.1.0 Docs</a> (41% documented)</p>
<p><a href="index.html">AliyunpanSDK 1.0 Docs</a> (41% documented)</p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -169,6 +169,9 @@
<li class="nav-group-task">
<a href="Enums/AliyunpanNetworkSystemError.html">AliyunpanNetworkSystemError</a>
</li>
<li class="nav-group-task">
<a href="Enums/DownloadState.html">DownloadState</a>
</li>
<li class="nav-group-task">
<a href="Enums/HTTPMethod.html">HTTPMethod</a>
</li>
Expand Down Expand Up @@ -199,6 +202,9 @@
<li class="nav-group-task">
<a href="Structs/AliyunpanClientConfig.html">AliyunpanClientConfig</a>
</li>
<li class="nav-group-task">
<a href="Structs/AliyunpanDownloadResult.html">AliyunpanDownloadResult</a>
</li>
<li class="nav-group-task">
<a href="Structs/AliyunpanFile.html">AliyunpanFile</a>
</li>
Expand Down Expand Up @@ -244,9 +250,6 @@
<li class="nav-group-task">
<a href="Structs/AliyunpanToken.html">AliyunpanToken</a>
</li>
<li class="nav-group-task">
<a href="Structs/DownloadResult.html">DownloadResult</a>
</li>
<li class="nav-group-task">
<a href="Structs/HTTPHeader.html">HTTPHeader</a>
</li>
Expand Down Expand Up @@ -469,7 +472,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/AliyunpanSDK" target="_blank" rel="external noopener">[email protected]</a>. All rights reserved. (Last updated: 2023-12-06)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/aliyunpan-ios-sdk" target="_blank" rel="external noopener">zhaixian</a>. All rights reserved. (Last updated: 2023-12-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
13 changes: 8 additions & 5 deletions docs/Classes/Aliyunpan.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Aliyunpan Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">AliyunpanSDK 0.1.0 Docs</a> (41% documented)</p>
<p><a href="../index.html">AliyunpanSDK 1.0 Docs</a> (41% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -169,6 +169,9 @@
<li class="nav-group-task">
<a href="../Enums/AliyunpanNetworkSystemError.html">AliyunpanNetworkSystemError</a>
</li>
<li class="nav-group-task">
<a href="../Enums/DownloadState.html">DownloadState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/HTTPMethod.html">HTTPMethod</a>
</li>
Expand Down Expand Up @@ -199,6 +202,9 @@
<li class="nav-group-task">
<a href="../Structs/AliyunpanClientConfig.html">AliyunpanClientConfig</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AliyunpanDownloadResult.html">AliyunpanDownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AliyunpanFile.html">AliyunpanFile</a>
</li>
Expand Down Expand Up @@ -244,9 +250,6 @@
<li class="nav-group-task">
<a href="../Structs/AliyunpanToken.html">AliyunpanToken</a>
</li>
<li class="nav-group-task">
<a href="../Structs/DownloadResult.html">DownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HTTPHeader.html">HTTPHeader</a>
</li>
Expand Down Expand Up @@ -443,7 +446,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/AliyunpanSDK" target="_blank" rel="external noopener">[email protected]</a>. All rights reserved. (Last updated: 2023-12-06)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/aliyunpan-ios-sdk" target="_blank" rel="external noopener">zhaixian</a>. All rights reserved. (Last updated: 2023-12-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
13 changes: 8 additions & 5 deletions docs/Classes/Aliyunpan/Environment.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Environment Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">AliyunpanSDK 0.1.0 Docs</a> (41% documented)</p>
<p><a href="../../index.html">AliyunpanSDK 1.0 Docs</a> (41% documented)</p>
<div class="header-right">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -169,6 +169,9 @@
<li class="nav-group-task">
<a href="../../Enums/AliyunpanNetworkSystemError.html">AliyunpanNetworkSystemError</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/DownloadState.html">DownloadState</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/HTTPMethod.html">HTTPMethod</a>
</li>
Expand Down Expand Up @@ -199,6 +202,9 @@
<li class="nav-group-task">
<a href="../../Structs/AliyunpanClientConfig.html">AliyunpanClientConfig</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/AliyunpanDownloadResult.html">AliyunpanDownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/AliyunpanFile.html">AliyunpanFile</a>
</li>
Expand Down Expand Up @@ -244,9 +250,6 @@
<li class="nav-group-task">
<a href="../../Structs/AliyunpanToken.html">AliyunpanToken</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/DownloadResult.html">DownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/HTTPHeader.html">HTTPHeader</a>
</li>
Expand Down Expand Up @@ -333,7 +336,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/AliyunpanSDK" target="_blank" rel="external noopener">[email protected]</a>. All rights reserved. (Last updated: 2023-12-06)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/aliyunpan-ios-sdk" target="_blank" rel="external noopener">zhaixian</a>. All rights reserved. (Last updated: 2023-12-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
108 changes: 11 additions & 97 deletions docs/Classes/AliyunpanClient.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="AliyunpanClient Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">AliyunpanSDK 0.1.0 Docs</a> (41% documented)</p>
<p><a href="../index.html">AliyunpanSDK 1.0 Docs</a> (41% documented)</p>
<div class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -169,6 +169,9 @@
<li class="nav-group-task">
<a href="../Enums/AliyunpanNetworkSystemError.html">AliyunpanNetworkSystemError</a>
</li>
<li class="nav-group-task">
<a href="../Enums/DownloadState.html">DownloadState</a>
</li>
<li class="nav-group-task">
<a href="../Enums/HTTPMethod.html">HTTPMethod</a>
</li>
Expand Down Expand Up @@ -199,6 +202,9 @@
<li class="nav-group-task">
<a href="../Structs/AliyunpanClientConfig.html">AliyunpanClientConfig</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AliyunpanDownloadResult.html">AliyunpanDownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AliyunpanFile.html">AliyunpanFile</a>
</li>
Expand Down Expand Up @@ -244,9 +250,6 @@
<li class="nav-group-task">
<a href="../Structs/AliyunpanToken.html">AliyunpanToken</a>
</li>
<li class="nav-group-task">
<a href="../Structs/DownloadResult.html">DownloadResult</a>
</li>
<li class="nav-group-task">
<a href="../Structs/HTTPHeader.html">HTTPHeader</a>
</li>
Expand Down Expand Up @@ -467,13 +470,10 @@ <h4>Declaration</h4>
<li class="item">
<div>
<code>
<a name="/s:12AliyunpanSDK0A6ClientC10downloader_2to27maxConcurrentOperationCountAA0A10DownloaderCAA0A4FileV_10Foundation3URLVSitYaKF"></a>
<a name="/s:12AliyunpanSDK0A6ClientC10downloader_2to27maxConcurrentOperationCountAA0A10DownloaderCAA0A4FileV_10Foundation3URLVSitF"></a>
<a name="//apple_ref/swift/Method/downloader(_:to:maxConcurrentOperationCount:)" class="dashAnchor"></a>
<a class="token" href="#/s:12AliyunpanSDK0A6ClientC10downloader_2to27maxConcurrentOperationCountAA0A10DownloaderCAA0A4FileV_10Foundation3URLVSitYaKF">downloader(_:<wbr>to:<wbr>maxConcurrentOperationCount:<wbr>)</a>
<a class="token" href="#/s:12AliyunpanSDK0A6ClientC10downloader_2to27maxConcurrentOperationCountAA0A10DownloaderCAA0A4FileV_10Foundation3URLVSitF">downloader(_:<wbr>to:<wbr>maxConcurrentOperationCount:<wbr>)</a>
</code>
<span class="declaration-note">
Asynchronous
</span>
</div>
<div class="height-container">
<div class="pointer-container"></div>
Expand All @@ -490,7 +490,7 @@ <h4>Declaration</h4>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">downloader</span><span class="p">(</span>
<span class="n">_</span> <span class="nv">file</span><span class="p">:</span> <span class="kt"><a href="../Structs/AliyunpanFile.html">AliyunpanFile</a></span><span class="p">,</span>
<span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
<span class="nv">maxConcurrentOperationCount</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">)</span> <span class="k">async</span> <span class="k">throws</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/AliyunpanDownloader.html">AliyunpanDownloader</a></span></code></pre>
<span class="nv">maxConcurrentOperationCount</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/AliyunpanDownloader.html">AliyunpanDownloader</a></span></code></pre>

</div>
</div>
Expand Down Expand Up @@ -540,98 +540,12 @@ <h4>Parameters</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12AliyunpanSDK0A6ClientC10downloader11downloadURL8fileSize2to27maxConcurrentOperationCountAA0A10DownloaderC10Foundation0F0V_s5Int64VAMSitF"></a>
<a name="//apple_ref/swift/Method/downloader(downloadURL:fileSize:to:maxConcurrentOperationCount:)" class="dashAnchor"></a>
<a class="token" href="#/s:12AliyunpanSDK0A6ClientC10downloader11downloadURL8fileSize2to27maxConcurrentOperationCountAA0A10DownloaderC10Foundation0F0V_s5Int64VAMSitF">downloader(downloadURL:<wbr>fileSize:<wbr>to:<wbr>maxConcurrentOperationCount:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>下载文件，会根据 4_000_000 字节自动分片</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">downloader</span><span class="p">(</span>
<span class="nv">downloadURL</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
<span class="nv">fileSize</span><span class="p">:</span> <span class="kt">Int64</span><span class="p">,</span>
<span class="n">to</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">URL</span><span class="p">,</span>
<span class="nv">maxConcurrentOperationCount</span><span class="p">:</span> <span class="kt">Int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt"><a href="../Classes/AliyunpanDownloader.html">AliyunpanDownloader</a></span></code></pre>

</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>downloadURL</em>
</code>
</td>
<td>
<div>
<p>getFileDownloadUrl 获取的下载地址</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fileSize</em>
</code>
</td>
<td>
<div>
<p>文件 size</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>destination</em>
</code>
</td>
<td>
<div>
<p>期望目标地址</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>maxConcurrentOperationCount</em>
</code>
</td>
<td>
<div>
<p>最大并发数，必须小于等于 10，默认 10</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/AliyunpanSDK" target="_blank" rel="external noopener">[email protected]</a>. All rights reserved. (Last updated: 2023-12-06)</p>
<p>&copy; 2023 <a class="link" href="https://github.com/alibaba/aliyunpan-ios-sdk" target="_blank" rel="external noopener">zhaixian</a>. All rights reserved. (Last updated: 2023-12-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading