mirror of
https://github.com/appwrite/sdk-for-dart.git
synced 2026-04-07 19:17:49 +00:00
root
334 lines
12 KiB
Dart
334 lines
12 KiB
Dart
part of '../dart_appwrite.dart';
|
|
|
|
/// The Storage service allows you to manage your project files.
|
|
class Storage extends Service {
|
|
Storage(super.client);
|
|
|
|
/// Get a list of all the storage buckets. You can use the query params to
|
|
/// filter your results.
|
|
Future<models.BucketList> listBuckets({List<String>? queries, String? search, bool? total}) async {
|
|
final String apiPath = '/storage/buckets';
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
if (queries != null) 'queries': queries,
|
|
if (search != null) 'search': search,
|
|
if (total != null) 'total': total,
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.BucketList.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Create a new storage bucket.
|
|
Future<models.Bucket> createBucket({required String bucketId, required String name, List<String>? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List<String>? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus, bool? transformations}) async {
|
|
final String apiPath = '/storage/buckets';
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
'bucketId': bucketId,
|
|
'name': name,
|
|
'permissions': permissions,
|
|
if (fileSecurity != null) 'fileSecurity': fileSecurity,
|
|
if (enabled != null) 'enabled': enabled,
|
|
if (maximumFileSize != null) 'maximumFileSize': maximumFileSize,
|
|
if (allowedFileExtensions != null) 'allowedFileExtensions': allowedFileExtensions,
|
|
if (compression != null) 'compression': compression.value,
|
|
if (encryption != null) 'encryption': encryption,
|
|
if (antivirus != null) 'antivirus': antivirus,
|
|
if (transformations != null) 'transformations': transformations,
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'application/json',
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.Bucket.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Get a storage bucket by its unique ID. This endpoint response returns a
|
|
/// JSON object with the storage bucket metadata.
|
|
Future<models.Bucket> getBucket({required String bucketId}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.Bucket.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Update a storage bucket by its unique ID.
|
|
Future<models.Bucket> updateBucket({required String bucketId, required String name, List<String>? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List<String>? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus, bool? transformations}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
'name': name,
|
|
'permissions': permissions,
|
|
if (fileSecurity != null) 'fileSecurity': fileSecurity,
|
|
if (enabled != null) 'enabled': enabled,
|
|
if (maximumFileSize != null) 'maximumFileSize': maximumFileSize,
|
|
if (allowedFileExtensions != null) 'allowedFileExtensions': allowedFileExtensions,
|
|
if (compression != null) 'compression': compression.value,
|
|
if (encryption != null) 'encryption': encryption,
|
|
if (antivirus != null) 'antivirus': antivirus,
|
|
if (transformations != null) 'transformations': transformations,
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'application/json',
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.Bucket.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Delete a storage bucket by its unique ID.
|
|
Future deleteBucket({required String bucketId}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'application/json',
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return res.data;
|
|
|
|
}
|
|
|
|
/// Get a list of all the user files. You can use the query params to filter
|
|
/// your results.
|
|
Future<models.FileList> listFiles({required String bucketId, List<String>? queries, String? search, bool? total}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
if (queries != null) 'queries': queries,
|
|
if (search != null) 'search': search,
|
|
if (total != null) 'total': total,
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.FileList.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Create a new file. Before using this route, you should create a new bucket
|
|
/// resource using either a [server
|
|
/// integration](https://appwrite.io/docs/server/storage#storageCreateBucket)
|
|
/// API or directly from your Appwrite console.
|
|
///
|
|
/// Larger files should be uploaded using multiple requests with the
|
|
/// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
|
|
/// header to send a partial request with a maximum supported chunk of `5MB`.
|
|
/// The `content-range` header values should always be in bytes.
|
|
///
|
|
/// When the first request is sent, the server will return the **File** object,
|
|
/// and the subsequent part request must include the file's **id** in
|
|
/// `x-appwrite-id` header to allow the server to know that the partial upload
|
|
/// is for the existing file and not for a new one.
|
|
///
|
|
/// If you're creating a new file using one of the Appwrite SDKs, all the
|
|
/// chunking logic will be managed by the SDK internally.
|
|
///
|
|
Future<models.File> createFile({required String bucketId, required String fileId, required InputFile file, List<String>? permissions, Function(UploadProgress)? onProgress}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
'fileId': fileId,
|
|
'file': file,
|
|
if (permissions != null) 'permissions': permissions,
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'multipart/form-data',
|
|
|
|
};
|
|
|
|
String idParamName = '';
|
|
idParamName = 'fileId';
|
|
final paramName = 'file';
|
|
final res = await client.chunkedUpload(
|
|
path: apiPath,
|
|
params: apiParams,
|
|
paramName: paramName,
|
|
idParamName: idParamName,
|
|
headers: apiHeaders,
|
|
onProgress: onProgress,
|
|
);
|
|
|
|
return models.File.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Get a file by its unique ID. This endpoint response returns a JSON object
|
|
/// with the file metadata.
|
|
Future<models.File> getFile({required String bucketId, required String fileId}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.File.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Update a file by its unique ID. Only users with write permissions have
|
|
/// access to update this resource.
|
|
Future<models.File> updateFile({required String bucketId, required String fileId, String? name, List<String>? permissions}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
if (name != null) 'name': name,
|
|
'permissions': permissions,
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'application/json',
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return models.File.fromMap(res.data);
|
|
|
|
}
|
|
|
|
/// Delete a file by its unique ID. Only users with write permissions have
|
|
/// access to delete this resource.
|
|
Future deleteFile({required String bucketId, required String fileId}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> apiParams = {
|
|
|
|
|
|
};
|
|
|
|
final Map<String, String> apiHeaders = {
|
|
'content-type': 'application/json',
|
|
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders);
|
|
|
|
return res.data;
|
|
|
|
}
|
|
|
|
/// Get a file content by its unique ID. The endpoint response return with a
|
|
/// 'Content-Disposition: attachment' header that tells the browser to start
|
|
/// downloading the file to user downloads directory.
|
|
Future<Uint8List> getFileDownload({required String bucketId, required String fileId, String? token}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> params = {
|
|
if (token != null) 'token': token,
|
|
|
|
|
|
'project': client.config['project'],
|
|
'session': client.config['session'],
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes);
|
|
return res.data;
|
|
}
|
|
|
|
/// Get a file preview image. Currently, this method supports preview for image
|
|
/// files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
|
|
/// and spreadsheets, will return the file icon image. You can also pass query
|
|
/// string arguments for cutting and resizing your preview image. Preview is
|
|
/// supported only for image files smaller than 10MB.
|
|
Future<Uint8List> getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> params = {
|
|
if (width != null) 'width': width,
|
|
if (height != null) 'height': height,
|
|
if (gravity != null) 'gravity': gravity.value,
|
|
if (quality != null) 'quality': quality,
|
|
if (borderWidth != null) 'borderWidth': borderWidth,
|
|
if (borderColor != null) 'borderColor': borderColor,
|
|
if (borderRadius != null) 'borderRadius': borderRadius,
|
|
if (opacity != null) 'opacity': opacity,
|
|
if (rotation != null) 'rotation': rotation,
|
|
if (background != null) 'background': background,
|
|
if (output != null) 'output': output.value,
|
|
if (token != null) 'token': token,
|
|
|
|
|
|
'project': client.config['project'],
|
|
'session': client.config['session'],
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes);
|
|
return res.data;
|
|
}
|
|
|
|
/// Get a file content by its unique ID. This endpoint is similar to the
|
|
/// download method but returns with no 'Content-Disposition: attachment'
|
|
/// header.
|
|
Future<Uint8List> getFileView({required String bucketId, required String fileId, String? token}) async {
|
|
final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId);
|
|
|
|
final Map<String, dynamic> params = {
|
|
if (token != null) 'token': token,
|
|
|
|
|
|
'project': client.config['project'],
|
|
'session': client.config['session'],
|
|
};
|
|
|
|
final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes);
|
|
return res.data;
|
|
}
|
|
} |