chore(storage): Added callout for storage pause feature (#3591)

aws-amplify · Sep 21, 2021 · e863726 · e863726
1 parent 0e3a75c
commit e863726
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/src/fragments/lib/storage/ios/download.mdx b/src/fragments/lib/storage/ios/download.mdx
@@ -110,6 +110,12 @@ func cancelDownload() {
 
 You can also pause and then resume the operation.
 
+<Callout>
+
+Note that pause internally uses the `suspend` api of `NSURLSessionTask`, which suspends the task temporarily and does not fully pause the transfer. Complete pausing of task is tracked in this Github issue - https://github.com/aws-amplify/aws-sdk-ios/issues/3668
+
+</Callout>
+
 ```swift
 storageOperation.pause()
 storageOperation.resume()

diff --git a/src/fragments/lib/storage/ios/upload.mdx b/src/fragments/lib/storage/ios/upload.mdx
@@ -124,6 +124,12 @@ func cancelUpload() {
 
 You can also pause then resume the operation.
 
+<Callout>
+
+Note that pause internally uses the `suspend` api of `NSURLSessionTask`, which suspends the task temporarily and does not fully pause the transfer. Complete pausing of task is tracked in this Github issue - https://github.com/aws-amplify/aws-sdk-ios/issues/3668
+
+</Callout>
+
 ```swift
 storageOperation.pause()
 storageOperation.resume()

diff --git a/src/fragments/sdk/storage/ios/transfer-utility.mdx b/src/fragments/sdk/storage/ios/transfer-utility.mdx
@@ -258,6 +258,12 @@ To pause a transfer, use the `suspend` method:
 refUploadTask.suspend()
 ```
 
+<Callout>
+
+Note that pause internally uses the `suspend` api of `NSURLSessionTask`, which suspends the task temporarily and does not fully pause the transfer. Complete pausing of task is tracked in this Github issue - https://github.com/aws-amplify/aws-sdk-ios/issues/3668
+
+</Callout>
+
 ## Resume a Transfer
 
 To resume a transfer, use the `resume` method: