Inheritance diagram for Cloud::Box::BoxStorage:

Public Member Functions
	BoxStorage (const Common::String &code, Networking::ErrorCallback cb)

	BoxStorage (const Networking::JsonResponse &codeFlowJson, Networking::ErrorCallback cb)

void	saveConfig (const Common::String &keyPrefix) override

Common::String	name () const override

Networking::Request *	listDirectoryById (const Common::String &id, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	createDirectoryWithParentId (const Common::String &parentId, const Common::String &directoryName, BoolCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	upload (const Common::String &remotePath, const Common::Path &localPath, UploadCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	upload (const Common::String &path, Common::SeekableReadStream *contents, UploadCallback callback, Networking::ErrorCallback errorCallback) override

bool	uploadStreamSupported () override

Networking::Request *	streamFileById (const Common::String &path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	info (StorageInfoCallback callback, Networking::ErrorCallback errorCallback) override

Common::String	savesDirectoryPath () override

Common::String	getRootDirectoryId () override

Common::String	accessToken () const

Public Member Functions inherited from Cloud::Id::IdStorage
	IdStorage (const Common::String &token, const Common::String &refreshToken, bool enabled)

virtual Networking::Request *	resolveFileId (const Common::String &path, UploadCallback callback, Networking::ErrorCallback errorCallback)

Networking::Request *	listDirectory (const Common::String &path, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback, bool recursive=false) override

Networking::Request *	createDirectory (const Common::String &path, BoolCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	streamFile (const Common::String &path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback) override

Networking::Request *	download (const Common::String &remotePath, const Common::Path &localPath, BoolCallback callback, Networking::ErrorCallback errorCallback) override

Public Member Functions inherited from Cloud::BaseStorage
	BaseStorage (const Common::String &token, const Common::String &refreshToken, bool enabled=false)

virtual void	refreshAccessToken (BoolCallback callback, Networking::ErrorCallback errorCallback=nullptr)

Public Member Functions inherited from Cloud::Storage
bool	isEnabled () const

void	enable ()

virtual Networking::Request *	downloadById (const Common::String &remoteId, const Common::Path &localPath, BoolCallback callback, Networking::ErrorCallback errorCallback)

virtual Networking::Request *	downloadFolder (const Common::String &remotePath, const Common::Path &localPath, FileArrayCallback callback, Networking::ErrorCallback errorCallback, bool recursive=false)

virtual SavesSyncRequest *	syncSaves (BoolCallback callback, Networking::ErrorCallback errorCallback)

virtual bool	isWorking ()

virtual bool	isSyncing ()

virtual double	getSyncDownloadingProgress ()

virtual void	getSyncDownloadingInfo (SyncDownloadingInfo &info)

virtual double	getSyncProgress ()

virtual Common::Array< Common::String >	getSyncingFiles ()

virtual void	cancelSync ()

virtual bool	startDownload (const Common::String &remotePath, const Common::Path &localPath)

virtual void	cancelDownload ()

virtual void	setDownloadTarget (GUI::CommandReceiver *target)

virtual bool	isDownloading ()

virtual double	getDownloadingProgress ()

virtual uint64	getDownloadBytesNumber ()

virtual uint64	getDownloadTotalBytesNumber ()

virtual uint64	getDownloadSpeed ()

virtual Common::String	getDownloadRemoteDirectory ()

virtual Common::Path	getDownloadLocalDirectory ()

Static Public Member Functions
static BoxStorage *	loadFromConfig (const Common::String &keyPrefix)

static void	removeFromConfig (const Common::String &keyPrefix)

Protected Member Functions
Common::String	cloudProvider () override

uint32	storageIndex () override

bool	needsRefreshToken () override

bool	canReuseRefreshToken () override

Protected Member Functions inherited from Cloud::Id::IdStorage
void	printFiles (const FileArrayResponse &response)

void	printBool (const BoolResponse &response)

void	printFile (const UploadResponse &response)

ListDirectoryCallback	getPrintFilesCallback ()

Protected Member Functions inherited from Cloud::BaseStorage
virtual void	getAccessToken (const Common::String &code, Networking::ErrorCallback callback)

virtual void	codeFlowComplete (Networking::ErrorCallback callback, const Networking::JsonResponse &response)

virtual void	codeFlowFailed (Networking::ErrorCallback callback, const Networking::ErrorResponse &error)

void	saveIsEnabledFlag (const Common::String &keyPrefix) const

Protected Member Functions inherited from Cloud::Storage
virtual Networking::ErrorCallback	getErrorPrintingCallback ()

virtual void	printErrorResponse (const Networking::ErrorResponse &error)

virtual Networking::Request *	addRequest (Networking::Request *request)

virtual void	requestFinishedCallback (Networking::Request *invalidRequestPointer)

virtual void	savesSyncDefaultCallback (const BoolResponse &response)

virtual void	savesSyncDefaultErrorCallback (const Networking::ErrorResponse &error)

virtual void	directoryDownloadedCallback (const FileArrayResponse &response)

virtual void	directoryDownloadedErrorCallback (const Networking::ErrorResponse &error)

Additional Inherited Members
Public Types inherited from Cloud::Storage
typedef Networking::Response< const Common::Array< StorageFile > & >	FileArrayResponse

typedef Networking::Response< const StorageInfo & >	StorageInfoResponse

typedef Networking::Response< bool >	BoolResponse

typedef Networking::Response< const StorageFile & >	UploadResponse

typedef Networking::Response< const Common::Array< StorageFile > & >	ListDirectoryResponse

typedef Common::BaseCallback< const FileArrayResponse & > *	FileArrayCallback

typedef Common::BaseCallback< const StorageInfoResponse & > *	StorageInfoCallback

typedef Common::BaseCallback< const BoolResponse & > *	BoolCallback

typedef Common::BaseCallback< const UploadResponse & > *	UploadCallback

typedef Common::BaseCallback< const ListDirectoryResponse & > *	ListDirectoryCallback

Static Protected Member Functions inherited from Cloud::BaseStorage
static bool	loadIsEnabledFlag (const Common::String &keyPrefix)

static void	removeIsEnabledFlag (const Common::String &keyPrefix)

Protected Attributes inherited from Cloud::BaseStorage
Common::String	_token

Common::String	_refreshToken

Protected Attributes inherited from Cloud::Storage
uint32	_runningRequestsCount

Common::Mutex	_runningRequestsMutex

SavesSyncRequest *	_savesSyncRequest

bool	_syncRestartRequestsed

FolderDownloadRequest *	_downloadFolderRequest

bool	_isEnabled

Constructor & Destructor Documentation

◆ BoxStorage() [1/2]

Cloud::Box::BoxStorage::BoxStorage	(	const Common::String &	code,
		Networking::ErrorCallback	cb
	)

This constructor uses OAuth code flow to get tokens.

◆ BoxStorage() [2/2]

Cloud::Box::BoxStorage::BoxStorage	(	const Networking::JsonResponse &	codeFlowJson,
		Networking::ErrorCallback	cb
	)

This constructor extracts tokens from JSON acquired via OAuth code flow.

Member Function Documentation

◆ cloudProvider()

Common::String Cloud::Box::BoxStorage::cloudProvider ( )

overrideprotectedvirtual

Returns: "box"

Implements Cloud::BaseStorage.

◆ storageIndex()

uint32 Cloud::Box::BoxStorage::storageIndex ( )

overrideprotectedvirtual

Returns: kStorageBoxId

Implements Cloud::BaseStorage.

◆ needsRefreshToken()

bool Cloud::Box::BoxStorage::needsRefreshToken ( )

overrideprotectedvirtual

Return whether storage needs refresh_token to work.

Implements Cloud::BaseStorage.

◆ canReuseRefreshToken()

bool Cloud::Box::BoxStorage::canReuseRefreshToken ( )

overrideprotectedvirtual

Return whether to expect new refresh_token on refresh.

Implements Cloud::BaseStorage.

◆ saveConfig()

void Cloud::Box::BoxStorage::saveConfig ( const Common::String & keyPrefix )

overridevirtual

Storage methods, which are used by CloudManager to save storage in configuration file. Save storage data using ConfMan.

Parameters

keyPrefix all saved keys must start with this prefix.

Note: every Storage must write keyPrefix + "type" key with common value (e.g. "Dropbox").

Implements Cloud::Storage.

◆ name()

Common::String Cloud::Box::BoxStorage::name ( ) const

overridevirtual

Return unique storage name.

Returns: some unique storage name (for example, "Dropbox (user@example.com)")

Implements Cloud::Storage.

◆ listDirectoryById()

Networking::Request* Cloud::Box::BoxStorage::listDirectoryById	(	const Common::String &	id,
		ListDirectoryCallback	callback,
		Networking::ErrorCallback	errorCallback
	)

overridevirtual

Public Cloud API comes down there.

Implements Cloud::Id::IdStorage.

◆ upload() [1/2]

Networking::Request* Cloud::Box::BoxStorage::upload	(	const Common::String &	remotePath,
		const Common::Path &	localPath,
		UploadCallback	callback,
		Networking::ErrorCallback	errorCallback
	)

overridevirtual

Returns UploadStatus struct with info about uploaded file.

Reimplemented from Cloud::Storage.

◆ upload() [2/2]

Networking::Request* Cloud::Box::BoxStorage::upload	(	const Common::String &	path,
		Common::SeekableReadStream *	contents,
		UploadCallback	callback,
		Networking::ErrorCallback	errorCallback
	)

overridevirtual

Returns StorageFile with info about uploaded file.

Implements Cloud::Storage.

◆ uploadStreamSupported()

bool Cloud::Box::BoxStorage::uploadStreamSupported ( )

overridevirtual

Returns whether Storage supports upload(ReadStream).

Reimplemented from Cloud::Storage.

◆ streamFileById()

Networking::Request* Cloud::Box::BoxStorage::streamFileById	(	const Common::String &	path,
		Networking::NetworkReadStreamCallback	callback,
		Networking::ErrorCallback	errorCallback
	)

overridevirtual

Returns pointer to Networking::NetworkReadStream.

Implements Cloud::Id::IdStorage.

◆ info()

Networking::Request* Cloud::Box::BoxStorage::info	(	StorageInfoCallback	callback,
		Networking::ErrorCallback	errorCallback
	)

overridevirtual

Returns the StorageInfo struct.

Implements Cloud::Storage.

◆ savesDirectoryPath()

Common::String Cloud::Box::BoxStorage::savesDirectoryPath ( )

overridevirtual

Returns storage's saves directory path with the trailing slash.

Implements Cloud::Storage.

◆ loadFromConfig()

static BoxStorage* Cloud::Box::BoxStorage::loadFromConfig ( const Common::String & keyPrefix )

static

Load token and user id from configs and return BoxStorage for those.

Returns: pointer to the newly created BoxStorage or 0 if some problem occurred.

◆ removeFromConfig()

static void Cloud::Box::BoxStorage::removeFromConfig ( const Common::String & keyPrefix )

static

Remove all BoxStorage-related data from config.

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

backends/cloud/box/boxstorage.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ BoxStorage() [1/2]

◆ BoxStorage() [2/2]

Member Function Documentation

◆ cloudProvider()

◆ storageIndex()

◆ needsRefreshToken()

◆ canReuseRefreshToken()

◆ saveConfig()

◆ name()

◆ listDirectoryById()

◆ upload() [1/2]

◆ upload() [2/2]

◆ uploadStreamSupported()

◆ streamFileById()

◆ info()

◆ savesDirectoryPath()

◆ loadFromConfig()

◆ removeFromConfig()