Skip to content

Commit 8576d44

Browse files
committed
chore: add doc comments for StorageUploadFileOperation pause and cancel
1 parent a3722f6 commit 8576d44

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

packages/amplify_core/lib/src/types/storage/upload_file_operation.dart

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,18 @@ abstract class StorageUploadFileOperation<
1818
required super.request,
1919
required super.result,
2020
});
21+
22+
/// Pauses the operation that is in progress.
23+
///
24+
/// This has no effect on S3 upload operations that do not require a multi part
25+
/// upload (over 5 MiB). Uploads smaller than 5 MiB cannot be paused or resumed.
26+
@override
27+
Future<void> pause();
28+
29+
/// Resumes the operation that is in a paused state.
30+
///
31+
/// This has no effect on S3 upload operations that do not require a multi part
32+
/// upload (over 5 MiB). Uploads smaller than 5 MiB cannot be paused or resumed.
33+
@override
34+
Future<void> resume();
2135
}

0 commit comments

Comments
 (0)