Storage class

The Nhost storage service.

Supports the storage and retrieval of files on the backend.

Constructors

Storage({required String baseUrl, required UserSession session, required Client httpClient})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

close() → void

Releases the object's resources.

delete(String filePath) → Future<void>

Deletes a file on the backend.

downloadFile(String filePath, {String? fileToken}) → Future<Response>

Downloads the file at the provided path.

downloadImage(String filePath, {String? fileToken, ImageTransformConfig? imageTransformConfig}) → Future<Response?>

Downloads the image at the provided path, transforming it if requested.

getDirectoryMetadata(String directoryPath) → Future<List<FileMetadata>>

Retrieves a directory's contents' metadata from the backend.

getFileMetadata(String filePath, {String? fileToken}) → Future<FileMetadata>

Retrieves a file's metadata from the backend.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

uploadBytes({required String filePath, required List<int> bytes, String contentType = applicationOctetStreamType, UploadProgressCallback? onUploadProgress}) → Future<FileMetadata>

Uploads a file to the backend from a list of bytes.

uploadString({required String filePath, required String string, String contentType = applicationOctetStreamType, UploadProgressCallback? onUploadProgress}) → Future<FileMetadata>

Uploads a file to the backend from a string.

Operators

operator ==(Object other) → bool

The equality operator.

inherited