ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

#include <dropboxstorage.h>

Inheritance diagram for Cloud::Dropbox::DropboxStorage:
Collaboration diagram for Cloud::Dropbox::DropboxStorage:

List of all members.

Public Member Functions

 DropboxStorage (Common::String code)
 This constructor uses OAuth code flow to get tokens.
virtual ~DropboxStorage ()
virtual void saveConfig (Common::String keyPrefix)
 Storage methods, which are used by CloudManager to save storage in configuration file.
virtual Common::String name () const
 Return unique storage name.
virtual Networking::RequestlistDirectory (Common::String path, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback, bool recursive=false)
 Public Cloud API comes down there.
virtual Networking::Requestupload (Common::String path, Common::SeekableReadStream *contents, UploadCallback callback, Networking::ErrorCallback errorCallback)
 Returns UploadStatus struct with info about uploaded file.
virtual Networking::RequeststreamFileById (Common::String path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback)
 Returns pointer to Networking::NetworkReadStream.
virtual Networking::RequestcreateDirectory (Common::String path, BoolCallback callback, Networking::ErrorCallback errorCallback)
 Calls the callback when finished.
virtual Networking::Requestinfo (StorageInfoCallback callback, Networking::ErrorCallback errorCallback)
 Returns the StorageInfo struct.
virtual Common::String savesDirectoryPath ()
 Returns storage's saves directory path with the trailing slash.

Static Public Member Functions

static DropboxStorageloadFromConfig (Common::String keyPrefix)
 Load token and user id from configs and return DropboxStorage for those.

Private Member Functions

 DropboxStorage (Common::String token, Common::String uid)
 This private constructor is called from loadFromConfig().
void getAccessToken (Common::String code)
void codeFlowComplete (Networking::JsonResponse response)
void codeFlowFailed (Networking::ErrorResponse error)

Static Private Member Functions

static void loadKeyAndSecret ()

Private Attributes

Common::String _token
Common::String _uid

Static Private Attributes

static char * KEY = nullptr
static char * SECRET = nullptr

Detailed Description

Definition at line 33 of file dropboxstorage.h.


Constructor & Destructor Documentation

Cloud::Dropbox::DropboxStorage::DropboxStorage ( Common::String  token,
Common::String  uid 
) [private]

This private constructor is called from loadFromConfig().

Definition at line 68 of file dropboxstorage.cpp.

Cloud::Dropbox::DropboxStorage::DropboxStorage ( Common::String  code  ) 

This constructor uses OAuth code flow to get tokens.

Definition at line 70 of file dropboxstorage.cpp.

Cloud::Dropbox::DropboxStorage::~DropboxStorage (  )  [virtual]

Definition at line 74 of file dropboxstorage.cpp.


Member Function Documentation

void Cloud::Dropbox::DropboxStorage::codeFlowComplete ( Networking::JsonResponse  response  )  [private]

Definition at line 94 of file dropboxstorage.cpp.

void Cloud::Dropbox::DropboxStorage::codeFlowFailed ( Networking::ErrorResponse  error  )  [private]

Definition at line 126 of file dropboxstorage.cpp.

Networking::Request * Cloud::Dropbox::DropboxStorage::createDirectory ( Common::String  path,
BoolCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Calls the callback when finished.

Implements Cloud::Storage.

Definition at line 165 of file dropboxstorage.cpp.

void Cloud::Dropbox::DropboxStorage::getAccessToken ( Common::String  code  )  [private]

Definition at line 76 of file dropboxstorage.cpp.

Networking::Request * Cloud::Dropbox::DropboxStorage::info ( StorageInfoCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Returns the StorageInfo struct.

Implements Cloud::Storage.

Definition at line 171 of file dropboxstorage.cpp.

Networking::Request * Cloud::Dropbox::DropboxStorage::listDirectory ( Common::String  path,
ListDirectoryCallback  callback,
Networking::ErrorCallback  errorCallback,
bool  recursive = false 
) [virtual]

Public Cloud API comes down there.

Returns ListDirectoryStatus struct with list of files.

Implements Cloud::Storage.

Definition at line 141 of file dropboxstorage.cpp.

DropboxStorage * Cloud::Dropbox::DropboxStorage::loadFromConfig ( Common::String  keyPrefix  )  [static]

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

Returns:
pointer to the newly created DropboxStorage or 0 if some problem occured.

Definition at line 179 of file dropboxstorage.cpp.

void Cloud::Dropbox::DropboxStorage::loadKeyAndSecret (  )  [static, private]

Definition at line 51 of file dropboxstorage.cpp.

Common::String Cloud::Dropbox::DropboxStorage::name (  )  const [virtual]

Return unique storage name.

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

Implements Cloud::Storage.

Definition at line 137 of file dropboxstorage.cpp.

void Cloud::Dropbox::DropboxStorage::saveConfig ( Common::String  keyPrefix  )  [virtual]

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.

Definition at line 132 of file dropboxstorage.cpp.

Common::String Cloud::Dropbox::DropboxStorage::savesDirectoryPath (  )  [virtual]

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

Implements Cloud::Storage.

Definition at line 177 of file dropboxstorage.cpp.

Networking::Request * Cloud::Dropbox::DropboxStorage::streamFileById ( Common::String  path,
Networking::NetworkReadStreamCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Returns pointer to Networking::NetworkReadStream.

Implements Cloud::Storage.

Definition at line 149 of file dropboxstorage.cpp.

Networking::Request * Cloud::Dropbox::DropboxStorage::upload ( Common::String  path,
Common::SeekableReadStream contents,
UploadCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Returns UploadStatus struct with info about uploaded file.

Implements Cloud::Storage.

Definition at line 145 of file dropboxstorage.cpp.


Member Data Documentation

char * Cloud::Dropbox::DropboxStorage::KEY = nullptr [static, private]

Definition at line 34 of file dropboxstorage.h.

char * Cloud::Dropbox::DropboxStorage::SECRET = nullptr [static, private]

Definition at line 34 of file dropboxstorage.h.


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


Generated on Sat May 18 2019 05:05:47 for ResidualVM by doxygen 1.7.1
curved edge   curved edge