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

#include <onedrivestorage.h>

Inheritance diagram for Cloud::OneDrive::OneDriveStorage:
Collaboration diagram for Cloud::OneDrive::OneDriveStorage:

List of all members.

Public Member Functions

 OneDriveStorage (Common::String code)
 This constructor uses OAuth code flow to get tokens.
virtual ~OneDriveStorage ()
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.
void getAccessToken (BoolCallback callback, Networking::ErrorCallback errorCallback=nullptr, Common::String code="")
 Gets new access_token.
Common::String accessToken () const

Static Public Member Functions

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

Private Member Functions

 OneDriveStorage (Common::String token, Common::String uid, 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 fileInfoCallback (Networking::NetworkReadStreamCallback outerCallback, Networking::JsonResponse response)

Static Private Member Functions

static void loadKeyAndSecret ()

Private Attributes

Common::String _token
Common::String _uid
Common::String _refreshToken

Static Private Attributes

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

Detailed Description

Definition at line 32 of file onedrivestorage.h.


Constructor & Destructor Documentation

Cloud::OneDrive::OneDriveStorage::OneDriveStorage ( Common::String  token,
Common::String  uid,
Common::String  refreshToken 
) [private]

This private constructor is called from loadFromConfig().

Definition at line 70 of file onedrivestorage.cpp.

Cloud::OneDrive::OneDriveStorage::OneDriveStorage ( Common::String  code  ) 

This constructor uses OAuth code flow to get tokens.

Definition at line 73 of file onedrivestorage.cpp.

Cloud::OneDrive::OneDriveStorage::~OneDriveStorage (  )  [virtual]

Definition at line 81 of file onedrivestorage.cpp.


Member Function Documentation

Common::String Cloud::OneDrive::OneDriveStorage::accessToken (  )  const [inline]

Definition at line 107 of file onedrivestorage.h.

void Cloud::OneDrive::OneDriveStorage::codeFlowComplete ( BoolResponse  response  )  [private]

Definition at line 154 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::codeFlowFailed ( Networking::ErrorResponse  error  )  [private]

Definition at line 166 of file onedrivestorage.cpp.

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

Calls the callback when finished.

Implements Cloud::Storage.

Definition at line 287 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::fileInfoCallback ( Networking::NetworkReadStreamCallback  outerCallback,
Networking::JsonResponse  response 
) [private]

Definition at line 231 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::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 onedrivestorage.cpp.

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

Returns the StorageInfo struct.

Implements Cloud::Storage.

Definition at line 293 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::infoInnerCallback ( StorageInfoCallback  outerCallback,
Networking::JsonResponse  json 
) [private]

Constructs StorageInfo based on JSON response from cloud.

Definition at line 182 of file onedrivestorage.cpp.

Networking::Request * Cloud::OneDrive::OneDriveStorage::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 271 of file onedrivestorage.cpp.

OneDriveStorage * Cloud::OneDrive::OneDriveStorage::loadFromConfig ( Common::String  keyPrefix  )  [static]

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

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

Definition at line 302 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::loadKeyAndSecret (  )  [static, private]

Definition at line 53 of file onedrivestorage.cpp.

Common::String Cloud::OneDrive::OneDriveStorage::name (  )  const [virtual]

Return unique storage name.

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

Implements Cloud::Storage.

Definition at line 178 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::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 172 of file onedrivestorage.cpp.

Common::String Cloud::OneDrive::OneDriveStorage::savesDirectoryPath (  )  [virtual]

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

Implements Cloud::Storage.

Definition at line 300 of file onedrivestorage.cpp.

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

Returns pointer to Networking::NetworkReadStream.

Implements Cloud::Storage.

Definition at line 279 of file onedrivestorage.cpp.

void Cloud::OneDrive::OneDriveStorage::tokenRefreshed ( BoolCallback  callback,
Networking::JsonResponse  response 
) [private]

Definition at line 116 of file onedrivestorage.cpp.

Networking::Request * Cloud::OneDrive::OneDriveStorage::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 275 of file onedrivestorage.cpp.


Member Data Documentation

char * Cloud::OneDrive::OneDriveStorage::KEY = nullptr [static, private]

Definition at line 33 of file onedrivestorage.h.

char * Cloud::OneDrive::OneDriveStorage::SECRET = nullptr [static, private]

Definition at line 33 of file onedrivestorage.h.


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


Generated on Sat Jan 12 2019 05:03:59 for ResidualVM by doxygen 1.7.1
curved edge   curved edge