You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: remove inaccuarte information about downloadData (#8273)
* chore: remove inaccuarte information about downloadData
* chore: resolve commments
* chore: add gen2 access type link for group access
* chore: fix heading order caused accessibility check failures
Copy file name to clipboardExpand all lines: src/fragments/lib/storage/ios/download.mdx
+5-5
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ There are three ways of getting data that was previously uploaded:
4
4
5
5
You can download to in-memory buffer [Data](https://developer.apple.com/documentation/foundation/data) object with `Amplify.Storage.downloadData`:
6
6
7
-
####With StoragePath
7
+
### With StoragePath
8
8
<BlockSwitcher>
9
9
10
10
<Blockname="Async/Await">
@@ -48,7 +48,7 @@ let resultSink = downloadTask
48
48
49
49
</BlockSwitcher>
50
50
51
-
####With Key (Deprecated)
51
+
### With Key (Deprecated)
52
52
<BlockSwitcher>
53
53
54
54
<Blockname="Async/Await">
@@ -96,7 +96,7 @@ let resultSink = downloadTask
96
96
97
97
You can download to a file [URL](https://developer.apple.com/documentation/foundation/url) with `Amplify.Storage.downloadFile`:
98
98
99
-
####With StoragePath
99
+
### With StoragePath
100
100
<BlockSwitcher>
101
101
102
102
<Blockname="Async/Await">
@@ -158,7 +158,7 @@ let resultSink = downloadTask
158
158
159
159
</BlockSwitcher>
160
160
161
-
####With Key (Deprecated)
161
+
### With Key (Deprecated)
162
162
<BlockSwitcher>
163
163
164
164
<Blockname="Async/Await">
@@ -296,4 +296,4 @@ downloadTask.resume()
296
296
297
297
Download tasks are run using `URLSessionTask` instances internally. You can learn more about them in [Apple's official documentation](https://developer.apple.com/documentation/foundation/urlsessiontask).
-`downloadData` is cached; if you have recently modified a file you may not get the latest version right away. You can pass in `cacheControl: 'no-cache'` to get the latest version.
1243
-
-`downloadData` only returns the latest cached version of the file; there is [not yet an API to view prior versions](https://github.com/aws-amplify/amplify-js/issues/2131).
1244
1242
-[Image compression](https://github.com/aws-amplify/amplify-js/issues/6081) or CloudFront CDN caching for your S3 buckets is not yet possible.
1245
-
-There is no API for [Cognito Group-based access to files](https://github.com/aws-amplify/amplify-js/issues/3388).
1246
-
-There is currently [no API for getting the `identityId` of other users](https://github.com/aws-amplify/amplify-js/issues/5177); you have to retrieve this from elsewhere before calling `Storage.get`.
1243
+
-`downloadData` does not provide a cache control option and it replies on runtime HTTP caching behavior. If you need to bypass the cache, you can use the `getUrl` API to create a presigned URL for downloading the file.
1244
+
-`downloadData` does not support S3 object versioning, it always downloads the latest version.
Copy file name to clipboardExpand all lines: src/pages/gen1/[platform]/build-a-backend/storage/download/index.mdx
+4-4
Original file line number
Diff line number
Diff line change
@@ -366,10 +366,10 @@ Learn more about how to setup an appropriate [CORS Policy](/gen1/[platform]/prev
366
366
367
367
Users can run into unexpected issues, so we are giving you advance notice in documentation with links to open issues - please vote for what you need, to help the team prioritize.
368
368
369
-
-`downloadData` is cached; if you have recently modified a file you may not get the latest version right away. You can pass in `cacheControl: 'no-cache'` to get the latest version.
370
-
-`downloadData` only returns the latest cached version of the file; there is [not yet an API to view prior versions](https://github.com/aws-amplify/amplify-js/issues/2131).
371
369
-[Image compression](https://github.com/aws-amplify/amplify-js/issues/6081) or CloudFront CDN caching for your S3 buckets is not yet possible.
372
-
- There is no API for [Cognito Group-based access to files](https://github.com/aws-amplify/amplify-js/issues/3388).
373
-
- There is currently [no API for getting the identityId of other users](https://github.com/aws-amplify/amplify-js/issues/5177); you have to retrieve this from elsewhere before calling `Storage.get`.
370
+
- There is currently [no API for getting the identityId of other users](https://github.com/aws-amplify/amplify-js/issues/5177); you have to retrieve this from elsewhere before calling `downloadData`.
371
+
-`downloadData` does not provide a cache control option and it replies on runtime HTTP caching behavior. If you need to bypass the cache, you can use the `getUrl` API to create a presigned URL for downloading the file.
372
+
-`downloadData` does not support S3 object versioning, it always downloads the latest version.
373
+
- There is no API for [Cognito Group-based access to files](https://github.com/aws-amplify/amplify-js/issues/3388). You may use [Amplify Gen2 Storage](/[platform]/build-a-backend/storage/authorization/#access-types) to achieve this.
0 commit comments