Storage Class Reference

Provides methods to interact with Appwrite's Storage service. More...

#include <Storage.hpp>

Collaboration diagram for Storage:

Public Member Functions
std::string	createBucket (const std::string &bucketId, const std::string &name, const std::vector< std::string > &permissions={}, bool fileSecurity=false, bool enabled=true, int maximumFileSize=0, const std::vector< std::string > &allowedFileExtensions={}, const std::string &compression="none", bool encryption=false, bool antivirus=false)
	Creates a new storage bucket.
std::string	createFile (const std::string &bucketId, const std::string &fileName, const std::string &fileContent, const std::vector< std::string > &permissions)
	Uploads a file to the specified bucket.
std::string	deleteBucket (std::string &bucketId)
	Deletes a storage bucket.
std::string	deleteFile (const std::string &bucketId, const std::string &fileId)
	Deletes a file from the bucket.
std::string	getBucket (std::string &bucketId)
	Retrieves metadata of a specific bucket.
std::string	getFile (const std::string &bucketId, const std::string &fileId)
	Retrieves metadata of a specific file.
std::string	getFileDownload (const std::string &bucketId, const std::string &fileId)
	Returns a downloadable URL for a file.
std::string	getFileView (const std::string &bucketId, const std::string &fileId)
	Returns a file preview URL.
std::string	listBuckets ()
	Lists all buckets in the project.
	Storage (const std::string &projectId, const std::string &apiKey)
	Constructs the Storage client with given project ID and API key.
std::string	updateBucket (const std::string &bucketId, const std::string &name, const std::vector< std::string > &permissions={}, bool fileSecurity=false, bool enabled=true, int maximumFileSize=0, const std::vector< std::string > &allowedFileExtensions={}, const std::string &compression="none", bool encryption=false, bool antivirus=false)
	Updates an existing storage bucket.
std::string	updateFile (const std::string &bucketId, const std::string &fileId, const std::string &name="", const std::vector< std::string > &permissions={})
	Updates file metadata and permissions.

Detailed Description

Provides methods to interact with Appwrite's Storage service.

Enables management of buckets and files including creation, retrieval, update, and deletion.

Definition at line 19 of file Storage.hpp.

Constructor & Destructor Documentation

Storage()

Storage::Storage	(	const std::string &	projectId,
		const std::string &	apiKey
	)

Constructs the Storage client with given project ID and API key.

Parameters

projectId	The unique identifier of the Appwrite project.
apiKey	The secret API key for authentication.

Member Function Documentation

createBucket()

std::string Storage::createBucket	(	const std::string &	bucketId,
		const std::string &	name,
		const std::vector< std::string > &	permissions = {},
		bool	fileSecurity = false,
		bool	enabled = true,
		int	maximumFileSize = 0,
		const std::vector< std::string > &	allowedFileExtensions = {},
		const std::string &	compression = "none",
		bool	encryption = false,
		bool	antivirus = false
	)

Creates a new storage bucket.

Parameters

bucketId	Unique ID for the bucket.
name	Name of the bucket.
permissions	Optional permissions list.
fileSecurity	Flag for enabling file-level security.
enabled	Enables or disables the bucket.
maximumFileSize	Optional max file size limit.
allowedFileExtensions	Optional list of allowed file extensions.
compression	Compression type ("none", "gzip", etc.).
encryption	Enable server-side encryption.
antivirus	Enable antivirus scanning.

Returns

JSON string with creation response.

createFile()

std::string Storage::createFile	(	const std::string &	bucketId,
		const std::string &	fileName,
		const std::string &	fileContent,
		const std::vector< std::string > &	permissions
	)

Uploads a file to the specified bucket.

Parameters

bucketId	Target bucket ID.
fileName	Name to give the file.
fileContent	File content (base64 or raw).
permissions	Optional permissions list.

Returns

JSON response string.

deleteBucket()

std::string Storage::deleteBucket

(

std::string &

bucketId

)

Deletes a storage bucket.

Parameters

bucketId

ID of the bucket to delete.

Returns

JSON response string.

deleteFile()

std::string Storage::deleteFile	(	const std::string &	bucketId,
		const std::string &	fileId
	)

Deletes a file from the bucket.

Parameters

bucketId	Bucket ID.
fileId	File ID.

Returns

JSON response string.

getBucket()

std::string Storage::getBucket

(

std::string &

bucketId

)

Retrieves metadata of a specific bucket.

Parameters

bucketId

ID of the bucket to retrieve.

Returns

JSON string containing bucket details.

getFile()

std::string Storage::getFile	(	const std::string &	bucketId,
		const std::string &	fileId
	)

Retrieves metadata of a specific file.

Parameters

bucketId	Bucket ID where file is stored.
fileId	Unique file identifier.

Returns

JSON string containing file metadata.

getFileDownload()

std::string Storage::getFileDownload	(	const std::string &	bucketId,
		const std::string &	fileId
	)

Returns a downloadable URL for a file.

Parameters

bucketId	Bucket ID.
fileId	File ID.

Returns

URL string for downloading the file.

getFileView()

std::string Storage::getFileView	(	const std::string &	bucketId,
		const std::string &	fileId
	)

Returns a file preview URL.

Parameters

bucketId	Bucket ID.
fileId	File ID.

Returns

URL string for viewing the file.

listBuckets()

std::string Storage::listBuckets

(

)

Lists all buckets in the project.

Returns

JSON string containing the list of buckets.

updateBucket()

std::string Storage::updateBucket	(	const std::string &	bucketId,
		const std::string &	name,
		const std::vector< std::string > &	permissions = {},
		bool	fileSecurity = false,
		bool	enabled = true,
		int	maximumFileSize = 0,
		const std::vector< std::string > &	allowedFileExtensions = {},
		const std::string &	compression = "none",
		bool	encryption = false,
		bool	antivirus = false
	)

Updates an existing storage bucket.

Parameters

bucketId	Unique ID of the bucket.
name	New name for the bucket.
permissions	Updated permissions list.
fileSecurity	Updated file-level security flag.
enabled	Whether the bucket is enabled.
maximumFileSize	Updated max file size limit.
allowedFileExtensions	Updated list of allowed extensions.
compression	Updated compression type.
encryption	Toggle encryption.
antivirus	Toggle antivirus.

Returns

JSON string with update response.

updateFile()

std::string Storage::updateFile	(	const std::string &	bucketId,
		const std::string &	fileId,
		const std::string &	name = "",
		const std::vector< std::string > &	permissions = {}
	)

Updates file metadata and permissions.

Parameters

bucketId	Bucket ID.
fileId	File ID.
name	New name for the file (optional).
permissions	New permissions list.

Returns

JSON response string.

---

The documentation for this class was generated from the following file:

• Storage.hpp