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

#include <boxstorage.h>

Inheritance diagram for Cloud::Box::BoxStorage:
Collaboration diagram for Cloud::Box::BoxStorage:

List of all members.

Public Member Functions

 BoxStorage (Common::String code)
 This constructor uses OAuth code flow to get tokens.
virtual ~BoxStorage ()
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::RequestlistDirectoryById (Common::String id, ListDirectoryCallback callback, Networking::ErrorCallback errorCallback)
 Public Cloud API comes down there.
virtual Networking::RequestcreateDirectoryWithParentId (Common::String parentId, Common::String directoryName, BoolCallback callback, Networking::ErrorCallback errorCallback)
virtual Networking::Requestupload (Common::String remotePath, Common::String localPath, UploadCallback callback, Networking::ErrorCallback errorCallback)
 Returns UploadStatus struct with info about uploaded file.
virtual Networking::Requestupload (Common::String path, Common::SeekableReadStream *contents, UploadCallback callback, Networking::ErrorCallback errorCallback)
 Returns StorageFile with info about uploaded file.
virtual bool uploadStreamSupported ()
 Returns whether Storage supports upload(ReadStream).
virtual Networking::RequeststreamFileById (Common::String path, Networking::NetworkReadStreamCallback callback, Networking::ErrorCallback errorCallback)
 Returns pointer to Networking::NetworkReadStream.
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.
virtual Common::String getRootDirectoryId ()
void getAccessToken (BoolCallback callback, Networking::ErrorCallback errorCallback=nullptr, Common::String code="")
 Gets new access_token.
Common::String accessToken () const

Static Public Member Functions

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

Private Member Functions

 BoxStorage (Common::String token, Common::String refreshToken)
 This private constructor is called from loadFromConfig().
void tokenRefreshed (BoolCallback callback, Networking::JsonResponse response)
void codeFlowComplete (BoolResponse response)
void codeFlowFailed (Networking::ErrorResponse error)
void infoInnerCallback (StorageInfoCallback outerCallback, Networking::JsonResponse json)
 Constructs StorageInfo based on JSON response from cloud.
void createDirectoryInnerCallback (BoolCallback outerCallback, Networking::JsonResponse response)

Static Private Member Functions

static void loadKeyAndSecret ()

Private Attributes

Common::String _token
Common::String _refreshToken

Static Private Attributes

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

Detailed Description

Definition at line 32 of file boxstorage.h.


Constructor & Destructor Documentation

Cloud::Box::BoxStorage::BoxStorage ( Common::String  token,
Common::String  refreshToken 
) [private]

This private constructor is called from loadFromConfig().

Definition at line 70 of file boxstorage.cpp.

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

This constructor uses OAuth code flow to get tokens.

Definition at line 73 of file boxstorage.cpp.

Cloud::Box::BoxStorage::~BoxStorage (  )  [virtual]

Definition at line 81 of file boxstorage.cpp.


Member Function Documentation

Common::String Cloud::Box::BoxStorage::accessToken (  )  const [inline]

Definition at line 110 of file boxstorage.h.

void Cloud::Box::BoxStorage::codeFlowComplete ( BoolResponse  response  )  [private]

Definition at line 154 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::codeFlowFailed ( Networking::ErrorResponse  error  )  [private]

Definition at line 165 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::createDirectoryInnerCallback ( BoolCallback  outerCallback,
Networking::JsonResponse  response 
) [private]

Definition at line 238 of file boxstorage.cpp.

Networking::Request * Cloud::Box::BoxStorage::createDirectoryWithParentId ( Common::String  parentId,
Common::String  directoryName,
BoolCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Implements Cloud::Id::IdStorage.

Definition at line 259 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::getAccessToken ( BoolCallback  callback,
Networking::ErrorCallback  errorCallback = nullptr,
Common::String  code = "" 
)

Gets new access_token.

If passed is "", refresh_token is used. Use "" in order to refresh token and pass a callback, so you could continue your work when new token is available.

Definition at line 83 of file boxstorage.cpp.

Common::String Cloud::Box::BoxStorage::getRootDirectoryId (  )  [virtual]

Implements Cloud::Id::IdStorage.

Definition at line 341 of file boxstorage.cpp.

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

Returns the StorageInfo struct.

Implements Cloud::Storage.

Definition at line 314 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::infoInnerCallback ( StorageInfoCallback  outerCallback,
Networking::JsonResponse  json 
) [private]

Constructs StorageInfo based on JSON response from cloud.

Definition at line 180 of file boxstorage.cpp.

Networking::Request * Cloud::Box::BoxStorage::listDirectoryById ( Common::String  id,
ListDirectoryCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Public Cloud API comes down there.

Implements Cloud::Id::IdStorage.

Definition at line 230 of file boxstorage.cpp.

BoxStorage * Cloud::Box::BoxStorage::loadFromConfig ( 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 occured.

Definition at line 323 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::loadKeyAndSecret (  )  [static, private]

Definition at line 53 of file boxstorage.cpp.

Common::String Cloud::Box::BoxStorage::name (  )  const [virtual]

Return unique storage name.

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

Implements Cloud::Storage.

Definition at line 176 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::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 171 of file boxstorage.cpp.

Common::String Cloud::Box::BoxStorage::savesDirectoryPath (  )  [virtual]

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

Implements Cloud::Storage.

Definition at line 321 of file boxstorage.cpp.

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

Returns pointer to Networking::NetworkReadStream.

Implements Cloud::Id::IdStorage.

Definition at line 301 of file boxstorage.cpp.

void Cloud::Box::BoxStorage::tokenRefreshed ( BoolCallback  callback,
Networking::JsonResponse  response 
) [private]

Definition at line 118 of file boxstorage.cpp.

Networking::Request * Cloud::Box::BoxStorage::upload ( Common::String  remotePath,
Common::String  localPath,
UploadCallback  callback,
Networking::ErrorCallback  errorCallback 
) [virtual]

Returns UploadStatus struct with info about uploaded file.

Reimplemented from Cloud::Storage.

Definition at line 282 of file boxstorage.cpp.

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

Returns StorageFile with info about uploaded file.

Implements Cloud::Storage.

Definition at line 288 of file boxstorage.cpp.

bool Cloud::Box::BoxStorage::uploadStreamSupported (  )  [virtual]

Returns whether Storage supports upload(ReadStream).

Reimplemented from Cloud::Storage.

Definition at line 297 of file boxstorage.cpp.


Member Data Documentation

Definition at line 37 of file boxstorage.h.

char * Cloud::Box::BoxStorage::KEY = nullptr [static, private]

Definition at line 33 of file boxstorage.h.

char * Cloud::Box::BoxStorage::SECRET = nullptr [static, private]

Definition at line 33 of file boxstorage.h.


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


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