S3Operations extension

High-level object operations implemented on top of S3Client.

These helpers provide convenient upload, download, existence, listing, and ACL operations for S3-compatible storage.

Example:

final ok = await client.putString(
  'uploads/hello.txt',
  'Hello S3',
);
on

Methods

deleteObject(String key) Future<bool>

Available on S3Client, provided by the S3Operations extension

Deletes an object using DELETE.
getObject(String key) Future<Uint8List?>

Available on S3Client, provided by the S3Operations extension

Downloads an object as raw bytes.
getString(String key) Future<String?>

Available on S3Client, provided by the S3Operations extension

Downloads an object and decodes it as UTF-8 text.
listObjects({String? prefix, int maxKeys = 1000}) Future<List<String>>

Available on S3Client, provided by the S3Operations extension

Lists object keys in the configured bucket.
objectExists(String key) Future<bool>

Available on S3Client, provided by the S3Operations extension

Checks whether an object exists using HEAD.
putObject({required String key, required Uint8List data, String? contentType, S3Acl? acl}) Future<bool>

Available on S3Client, provided by the S3Operations extension

Uploads raw bytes to S3 using PUT.
putString(String key, String data, {String? contentType, S3Acl? acl}) Future<bool>

Available on S3Client, provided by the S3Operations extension

Uploads a string to S3.
setObjectAcl(String key, S3Acl acl) Future<bool>

Available on S3Client, provided by the S3Operations extension

Applies a canned ACL to an existing object.