Skip to content

Commit

Permalink
chore: add doc comments for StorageUploadFileOperation pause and ca…
Browse files Browse the repository at this point in the history
…ncel
  • Loading branch information
Jordan-Nelson committed Jun 27, 2024
1 parent 6be4923 commit b743260
Showing 1 changed file with 14 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,18 @@ abstract class StorageUploadFileOperation<
required super.request,
required super.result,
});

/// Pauses the operation that is in progress.
///
/// This has no effect on S3 upload operations that do not require a multi part
/// upload (over 5 MiB). Uploads smaller than 5 MiB cannot be paused or resumed.
@override
Future<void> pause();

/// Resumes the operation that is in a paused state.
///
/// This has no effect on S3 upload operations that do not require a multi part
/// upload (over 5 MiB). Uploads smaller than 5 MiB cannot be paused or resumed.
@override
Future<void> resume();
}

0 comments on commit b743260

Please sign in to comment.