Dropbox Class

Properties   Methods   Events   Config Settings   Errors  

The Dropbox class makes it easy to upload, download, and manage files and folders within Dropbox.

Syntax

Dropbox

Remarks

The Dropbox class provides a simple interface to working with Dropbox. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying resources, and more.

Authentication

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The class has the following defaults:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Dropbox dropbox = new Dropbox(); dropbox.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; dropbox.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; dropbox.OAuth.ClientId = CLIENT_ID; dropbox.OAuth.ClientSecret = CLIENT_SECRET; dropbox.Config("OAuthWebServerPort=PORT"); // http://localhost:PORT needs to be a registered redirect URL for the app dropbox.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://www.dropbox.com/oauth2/authorize"; oauth.ServerTokenURL = "https://api.dropboxapi.com/oauth2/token"; oauth.WebServerPort = PORT; // http://localhost:PORT needs to be a registered redirect URL for the app dropbox.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Addressing Resources

Dropbox typically allows resources to be addressed in multiple ways:

• Using a path (e.g., /path/to/resource.txt).
• Using a resource Id (e.g, id:xxxxx).
• Using an Id-based relative path (e.g., id:xxxxx/relative/path/test.txt, where the Id is that of a folder resource).
• For certain methods, using a revision Id (e.g., rev:xxxxx).

Listing Resources

ListResources lists resources within the specified folder. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned. // ResourceList event handler. dropbox.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { dropbox.ListResources("/work_files/serious_business/cats"); for (int i = 0; i < dropbox.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(dropbox.ResourceMarker));

Downloading Files

The DownloadFile method downloads file resources.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: dropbox.LocalFile = "../MyFile.zip"; dropbox.DownloadFile(dropbox.Resources[0].Id);

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; dropbox.LocalFile = downloadFile; dropbox.DownloadFile(dropbox.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file dropbox.StartByte = new FileInfo(downloadFile).Length; dropbox.DownloadFile(dropbox.Resources[0].Id);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. dropbox.LocalFile = "../MyFile.zip"; dropbox.EncryptionPassword = "password"; dropbox.DownloadFile(dropbox.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file dropbox.StartByte = new FileInfo(dropbox.Config("DownloadTempFile")).Length; dropbox.DownloadFile(dropbox.Resources[0].Id);

Uploading Files

The UploadFile method uploads new file resources.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

Dropbox offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. dropbox.LocalFile = "../MyFile.zip"; dropbox.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. UploadSessionId is populated with a resumable upload session Id identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that UploadSessionId and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. dropbox.LocalFile = "../MyFile.zip"; dropbox.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. dropbox.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); dropbox.SetUploadStream(uploadStream); dropbox.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; dropbox.UploadFile("MyFile.zip");

Additional Functionality

The Dropbox class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, and MoveResource.
• Support for resource sharing using CreateLink, ListSharedLinks, and RevokeLink.
• Change tracking with ListChanges and WaitForChanges.
• Advanced resource listing using the Search method.
• Retrieval of account and space usage details using GetAccountInfo.
• File revision handling with ListRevisions and RestoreResource.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Account Property (Dropbox Class)

Details about the current user's account and space usage.

Syntax

• C++
• C
• Qt

CloudStorageDropboxAccount* GetAccount();

char* cloudstorage_dropbox_getaccountcountry(void* lpObj);

char* cloudstorage_dropbox_getaccountdisplayname(void* lpObj);

char* cloudstorage_dropbox_getaccountemail(void* lpObj);

char* cloudstorage_dropbox_getaccountfirstname(void* lpObj);

char* cloudstorage_dropbox_getaccountid(void* lpObj);

char* cloudstorage_dropbox_getaccountlastname(void* lpObj);

char* cloudstorage_dropbox_getaccountteamid(void* lpObj);

char* cloudstorage_dropbox_getaccountteammemberid(void* lpObj);

char* cloudstorage_dropbox_getaccountteamname(void* lpObj);

int64 cloudstorage_dropbox_getaccountteamtotalspace(void* lpObj);

int64 cloudstorage_dropbox_getaccountteamusedspace(void* lpObj);

int64 cloudstorage_dropbox_getaccounttotalspace(void* lpObj);

int cloudstorage_dropbox_getaccounttype(void* lpObj);

int64 cloudstorage_dropbox_getaccountusedspace(void* lpObj);

QString GetAccountCountry();

QString GetAccountDisplayName();

QString GetAccountEmail();

QString GetAccountFirstName();

QString GetAccountId();

QString GetAccountLastName();

QString GetAccountTeamId();

QString GetAccountTeamMemberId();

QString GetAccountTeamName();

qint64 GetAccountTeamTotalSpace();

qint64 GetAccountTeamUsedSpace();

qint64 GetAccountTotalSpace();

int GetAccountType();

qint64 GetAccountUsedSpace();

Remarks

This property holds a DropboxAccount object with information about the current user's account and space usage; it's populated after calling GetAccountInfo.

This property is read-only and not available at design time.

Data Type

CloudStorageDropboxAccount

Authorization Property (Dropbox Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudstorage_dropbox_getauthorization(void* lpObj);
int cloudstorage_dropbox_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth class or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

Data Type

String

ChangeMarker Property (Dropbox Class)

A marker indicating what page of changes to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChangeMarker();
int SetChangeMarker(const char* lpszChangeMarker);

Unicode (Windows)
LPWSTR GetChangeMarker();
INT SetChangeMarker(LPCWSTR lpszChangeMarker);

char* cloudstorage_dropbox_getchangemarker(void* lpObj);
int cloudstorage_dropbox_setchangemarker(void* lpObj, const char* lpszChangeMarker);

QString GetChangeMarker();
int SetChangeMarker(QString qsChangeMarker);

Default Value

""

Remarks

This property will be populated when ListChanges is called if the results are paged and there are more pages. To list all changes, continue to call ListChanges until this property returns empty string.

Setting ChangeMarker will cause NextChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

DownloadType Property (Dropbox Class)

The download type to use for file resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDownloadType();
int SetDownloadType(int iDownloadType);

Unicode (Windows)
INT GetDownloadType();
INT SetDownloadType(INT iDownloadType);

DDT_FILE_CONTENT(0), 
DDT_FILE_THUMBNAIL(1), 
DDT_FILE_PREVIEW(2)

int cloudstorage_dropbox_getdownloadtype(void* lpObj);
int cloudstorage_dropbox_setdownloadtype(void* lpObj, int iDownloadType);

int GetDownloadType();
int SetDownloadType(int iDownloadType);

Default Value

0

Remarks

This property controls what the class will download when DownloadFile is called for a file resource. Possible values are:

File thumbnails may be customized using the ThumbnailFormat, ThumbnailMode, and ThumbnailSize configuration settings; and are supported for the following file types: .bmp, .gif, .jpeg, .jpg, .png, .tif, and .tiff.

File previews are supported for the following file types:

• PDF-based: .ai, .doc, .docm, .docx, .eps, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, and .rtf.
• HTML-based: .csv, .ods, .xls, .xlsm, and .xlsx

This property is not available at design time.

Data Type

Integer

EncryptionAlgorithm Property (Dropbox Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

EA_AES(0), 
EA_BLOWFISH(1), 
EA_CAST(2), 
EA_DES(3), 
EA_IDEA(4), 
EA_RC2(5), 
EA_RC4(6), 
EA_TEA(7), 
EA_TRIPLE_DES(8), 
EA_TWOFISH(9), 
EA_RIJNDAEL(10), 
EA_CHA_CHA(11), 
EA_XSALSA_20(12)

int cloudstorage_dropbox_getencryptionalgorithm(void* lpObj);
int cloudstorage_dropbox_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (Dropbox Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* cloudstorage_dropbox_getencryptionpassword(void* lpObj);
int cloudstorage_dropbox_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

Firewall Property (Dropbox Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudStorageFirewall* GetFirewall();
int SetFirewall(CloudStorageFirewall* val);

int cloudstorage_dropbox_getfirewallautodetect(void* lpObj);
int cloudstorage_dropbox_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_dropbox_getfirewalltype(void* lpObj);
int cloudstorage_dropbox_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_dropbox_getfirewallhost(void* lpObj);
int cloudstorage_dropbox_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_dropbox_getfirewallpassword(void* lpObj);
int cloudstorage_dropbox_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_dropbox_getfirewallport(void* lpObj);
int cloudstorage_dropbox_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_dropbox_getfirewalluser(void* lpObj);
int cloudstorage_dropbox_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudStorageFirewall

Idle Property (Dropbox Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_dropbox_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (Dropbox Class)

The location of the local file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudstorage_dropbox_getlocalfile(void* lpObj);
wchar_t* cloudstorage_dropbox_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_dropbox_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_dropbox_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling UploadFile, and as the destination file when calling DownloadFile.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

Data Type

String

LocalHost Property (Dropbox Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudstorage_dropbox_getlocalhost(void* lpObj);
int cloudstorage_dropbox_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NextChangeMarker Property (Dropbox Class)

A marker indicating what page of changes to return in the future.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNextChangeMarker();
int SetNextChangeMarker(const char* lpszNextChangeMarker);

Unicode (Windows)
LPWSTR GetNextChangeMarker();
INT SetNextChangeMarker(LPCWSTR lpszNextChangeMarker);

char* cloudstorage_dropbox_getnextchangemarker(void* lpObj);
int cloudstorage_dropbox_setnextchangemarker(void* lpObj, const char* lpszNextChangeMarker);

QString GetNextChangeMarker();
int SetNextChangeMarker(QString qsNextChangeMarker);

Default Value

""

Remarks

This property will be populated when ListChanges is called if there are no more changes to list.

This property will be populated with the most current change marker if GetCurrentChangeMarker is called.

Setting NextChangeMarker will cause ChangeMarker to be set to empty string.

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuth Property (Dropbox Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudStorageOAuthSettings* GetOAuth();

char* cloudstorage_dropbox_getoauthaccesstoken(void* lpObj);
int cloudstorage_dropbox_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudstorage_dropbox_getoauthauthorizationcode(void* lpObj);
int cloudstorage_dropbox_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudstorage_dropbox_getoauthauthorizationscope(void* lpObj);
int cloudstorage_dropbox_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudstorage_dropbox_getoauthclientid(void* lpObj);
int cloudstorage_dropbox_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudstorage_dropbox_getoauthclientprofile(void* lpObj);
int cloudstorage_dropbox_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudstorage_dropbox_getoauthclientsecret(void* lpObj);
int cloudstorage_dropbox_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudstorage_dropbox_getoauthgranttype(void* lpObj);
int cloudstorage_dropbox_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudstorage_dropbox_getoauthrefreshtoken(void* lpObj);
int cloudstorage_dropbox_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudstorage_dropbox_getoauthrequestrefreshtoken(void* lpObj);
int cloudstorage_dropbox_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudstorage_dropbox_getoauthreturnurl(void* lpObj);
int cloudstorage_dropbox_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudstorage_dropbox_getoauthserverauthurl(void* lpObj);
int cloudstorage_dropbox_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudstorage_dropbox_getoauthservertokenurl(void* lpObj);
int cloudstorage_dropbox_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudstorage_dropbox_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

This property is read-only and not available at design time.

Data Type

CloudStorageOAuthSettings

OtherHeaders Property (Dropbox Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudstorage_dropbox_getotherheaders(void* lpObj);
int cloudstorage_dropbox_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (Dropbox Class)

Whether to overwrite the local or remote file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudstorage_dropbox_getoverwrite(void* lpObj);
int cloudstorage_dropbox_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be overwritten if it already exists. If the RenameIfExists configuration setting is enabled, this property is ignored and the server will renamed the newly-uploaded file instead (if necessary).

Data Type

Boolean

ParsedHeaders Property (Dropbox Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_dropbox_getparsedheadercount(void* lpObj);

char* cloudstorage_dropbox_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* cloudstorage_dropbox_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Data Type

CloudStorageHeader

Proxy Property (Dropbox Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudStorageProxy* GetProxy();
int SetProxy(CloudStorageProxy* val);

int cloudstorage_dropbox_getproxyauthscheme(void* lpObj);
int cloudstorage_dropbox_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_dropbox_getproxyautodetect(void* lpObj);
int cloudstorage_dropbox_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_dropbox_getproxypassword(void* lpObj);
int cloudstorage_dropbox_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_dropbox_getproxyport(void* lpObj);
int cloudstorage_dropbox_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_dropbox_getproxyserver(void* lpObj);
int cloudstorage_dropbox_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_dropbox_getproxyssl(void* lpObj);
int cloudstorage_dropbox_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_dropbox_getproxyuser(void* lpObj);
int cloudstorage_dropbox_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudStorageProxy

QueryParams Property (Dropbox Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageQueryParam>* GetQueryParams();
int SetQueryParams(CloudStorageList<CloudStorageQueryParam>* val);

int cloudstorage_dropbox_getqueryparamcount(void* lpObj);
int cloudstorage_dropbox_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_dropbox_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_dropbox_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_dropbox_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_dropbox_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Data Type

CloudStorageQueryParam

ResourceData Property (Dropbox Class)

The data that was downloaded, or that should be uploaded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceData(char* &lpResourceData, int &lenResourceData);
int SetResourceData(const char* lpResourceData, int lenResourceData);

Unicode (Windows)
INT GetResourceData(LPSTR &lpResourceData, INT &lenResourceData);
INT SetResourceData(LPCSTR lpResourceData, INT lenResourceData);

int cloudstorage_dropbox_getresourcedata(void* lpObj, char** lpResourceData, int* lenResourceData);
int cloudstorage_dropbox_setresourcedata(void* lpObj, const char* lpResourceData, int lenResourceData);

QByteArray GetResourceData();
int SetResourceData(QByteArray qbaResourceData);

Default Value

""

Remarks

This property is populated with file data after calling DownloadFile if SetDownloadStream and LocalFile are not set.

This property can also be set before calling UploadFile; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (Dropbox Class)

A marker indicating what page of resources to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceMarker();
int SetResourceMarker(const char* lpszResourceMarker);

Unicode (Windows)
LPWSTR GetResourceMarker();
INT SetResourceMarker(LPCWSTR lpszResourceMarker);

char* cloudstorage_dropbox_getresourcemarker(void* lpObj);
int cloudstorage_dropbox_setresourcemarker(void* lpObj, const char* lpszResourceMarker);

QString GetResourceMarker();
int SetResourceMarker(QString qsResourceMarker);

Default Value

""

Remarks

This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.

Refer to ListResources for more information.

This property is not available at design time.

Data Type

String

Resources Property (Dropbox Class)

A collection of resources.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageDropboxResource>* GetResources();
int SetResources(CloudStorageList<CloudStorageDropboxResource>* val);

int cloudstorage_dropbox_getresourcecount(void* lpObj);
int cloudstorage_dropbox_setresourcecount(void* lpObj, int iResourceCount);

int cloudstorage_dropbox_getresourceaccesstype(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourceclientmodifiedtime(void* lpObj, int resourceindex);

int cloudstorage_dropbox_getresourcedeleted(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourceexportextension(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourcehash(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourceid(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourcemodifiedtime(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourcename(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourceparentshareid(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourcepath(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourcerevision(void* lpObj, int resourceindex);

char* cloudstorage_dropbox_getresourceshareid(void* lpObj, int resourceindex);

int64 cloudstorage_dropbox_getresourcesize(void* lpObj, int resourceindex);

int cloudstorage_dropbox_getresourcetype(void* lpObj, int resourceindex);

int GetResourceCount();
int SetResourceCount(int iResourceCount);

int GetResourceAccessType(int iResourceIndex);

QString GetResourceClientModifiedTime(int iResourceIndex);

bool GetResourceDeleted(int iResourceIndex);

QString GetResourceExportExtension(int iResourceIndex);

QString GetResourceHash(int iResourceIndex);

QString GetResourceId(int iResourceIndex);

QString GetResourceModifiedTime(int iResourceIndex);

QString GetResourceName(int iResourceIndex);

QString GetResourceParentShareId(int iResourceIndex);

QString GetResourcePath(int iResourceIndex);

QString GetResourceRevision(int iResourceIndex);

QString GetResourceShareId(int iResourceIndex);

qint64 GetResourceSize(int iResourceIndex);

int GetResourceType(int iResourceIndex);

Remarks

This collection holds a list of file and folder resources.

Calling ListResources, GetResourceInfo, Search, ListChanges, or ListRevisions will populate this collection.

This property is not available at design time.

Data Type

CloudStorageDropboxResource

SearchCategories Property (Dropbox Class)

Resource categories to restrict the search to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchCategories();
int SetSearchCategories(const char* lpszSearchCategories);

Unicode (Windows)
LPWSTR GetSearchCategories();
INT SetSearchCategories(LPCWSTR lpszSearchCategories);

char* cloudstorage_dropbox_getsearchcategories(void* lpObj);
int cloudstorage_dropbox_setsearchcategories(void* lpObj, const char* lpszSearchCategories);

QString GetSearchCategories();
int SetSearchCategories(QString qsSearchCategories);

Default Value

""

Remarks

This property may be set to a comma-separated list of resource categories to restrict the search results returned by Search. Possible categories include:

The list of valid categories (and their associated file extensions) is defined by Dropbox and may change at any time; refer to the Dropbox API documentation for more information.

Note that the server will only apply this search restriction when SearchKind is set to dskActive (0).

This property is not available at design time.

Data Type

String

SearchFileExtensions Property (Dropbox Class)

File extensions to restrict the search to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchFileExtensions();
int SetSearchFileExtensions(const char* lpszSearchFileExtensions);

Unicode (Windows)
LPWSTR GetSearchFileExtensions();
INT SetSearchFileExtensions(LPCWSTR lpszSearchFileExtensions);

char* cloudstorage_dropbox_getsearchfileextensions(void* lpObj);
int cloudstorage_dropbox_setsearchfileextensions(void* lpObj, const char* lpszSearchFileExtensions);

QString GetSearchFileExtensions();
int SetSearchFileExtensions(QString qsSearchFileExtensions);

Default Value

""

Remarks

This property may be set to a comma-separated list of file extensions to restrict the search results returned by Search. File extensions should be specified without leading dot (.) characters.

Note that the server will only apply this search restriction when SearchKind is set to dskActive (0).

This property is not available at design time.

Data Type

String

SearchKind Property (Dropbox Class)

The kind of resources to search for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchKind();
int SetSearchKind(int iSearchKind);

Unicode (Windows)
INT GetSearchKind();
INT SetSearchKind(INT iSearchKind);

DSK_ACTIVE(0), 
DSK_DELETED(1)

int cloudstorage_dropbox_getsearchkind(void* lpObj);
int cloudstorage_dropbox_setsearchkind(void* lpObj, int iSearchKind);

int GetSearchKind();
int SetSearchKind(int iSearchKind);

Default Value

0

Remarks

This property specifies what kind of resources to search for when Search is called. Possible values are:

This property is not available at design time.

Data Type

Integer

SearchMarker Property (Dropbox Class)

A marker indicating what page of search results to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchMarker();
int SetSearchMarker(const char* lpszSearchMarker);

Unicode (Windows)
LPWSTR GetSearchMarker();
INT SetSearchMarker(LPCWSTR lpszSearchMarker);

char* cloudstorage_dropbox_getsearchmarker(void* lpObj);
int cloudstorage_dropbox_setsearchmarker(void* lpObj, const char* lpszSearchMarker);

QString GetSearchMarker();
int SetSearchMarker(QString qsSearchMarker);

Default Value

""

Remarks

This property will be populated when Search is called if the results are paged and there are more pages. To list all search results, continue to call Search until this property returns empty string.

Refer to Search for more information.

This property is not available at design time.

Data Type

String

SearchNamesOnly Property (Dropbox Class)

Whether to match against resource names only when searching.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchNamesOnly();
int SetSearchNamesOnly(int bSearchNamesOnly);

Unicode (Windows)
BOOL GetSearchNamesOnly();
INT SetSearchNamesOnly(BOOL bSearchNamesOnly);

int cloudstorage_dropbox_getsearchnamesonly(void* lpObj);
int cloudstorage_dropbox_setsearchnamesonly(void* lpObj, int bSearchNamesOnly);

bool GetSearchNamesOnly();
int SetSearchNamesOnly(bool bSearchNamesOnly);

Default Value

FALSE

Remarks

This property indicates whether the server should only match the query string passed to Search against resource names. If this property is disabled (default), the server will match the specified query string against resource details and/or content at its discretion.

This property is not available at design time.

Data Type

Boolean

SharedLinkMarker Property (Dropbox Class)

A marker indicating what page of shared links to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSharedLinkMarker();
int SetSharedLinkMarker(const char* lpszSharedLinkMarker);

Unicode (Windows)
LPWSTR GetSharedLinkMarker();
INT SetSharedLinkMarker(LPCWSTR lpszSharedLinkMarker);

char* cloudstorage_dropbox_getsharedlinkmarker(void* lpObj);
int cloudstorage_dropbox_setsharedlinkmarker(void* lpObj, const char* lpszSharedLinkMarker);

QString GetSharedLinkMarker();
int SetSharedLinkMarker(QString qsSharedLinkMarker);

Default Value

""

Remarks

This property will be populated when ListSharedLinks is called if the results are paged and there are more pages. To list all shared links, continue to call ListSharedLinks until this property returns empty string.

Refer to ListSharedLinks for more information

This property is not available at design time.

Data Type

String

SharedLinks Property (Dropbox Class)

A collection of shared links created by the current user.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageDropboxSharedLink>* GetSharedLinks();
int SetSharedLinks(CloudStorageList<CloudStorageDropboxSharedLink>* val);

int cloudstorage_dropbox_getsharedlinkcount(void* lpObj);
int cloudstorage_dropbox_setsharedlinkcount(void* lpObj, int iSharedLinkCount);

int cloudstorage_dropbox_getsharedlinkcanrevoke(void* lpObj, int sharedlinkindex);

char* cloudstorage_dropbox_getsharedlinkexpires(void* lpObj, int sharedlinkindex);

char* cloudstorage_dropbox_getsharedlinkid(void* lpObj, int sharedlinkindex);

char* cloudstorage_dropbox_getsharedlinkname(void* lpObj, int sharedlinkindex);

char* cloudstorage_dropbox_getsharedlinkpath(void* lpObj, int sharedlinkindex);

int cloudstorage_dropbox_getsharedlinktype(void* lpObj, int sharedlinkindex);

char* cloudstorage_dropbox_getsharedlinkurl(void* lpObj, int sharedlinkindex);

int cloudstorage_dropbox_getsharedlinkvisibility(void* lpObj, int sharedlinkindex);

int GetSharedLinkCount();
int SetSharedLinkCount(int iSharedLinkCount);

bool GetSharedLinkCanRevoke(int iSharedLinkIndex);

QString GetSharedLinkExpires(int iSharedLinkIndex);

QString GetSharedLinkId(int iSharedLinkIndex);

QString GetSharedLinkName(int iSharedLinkIndex);

QString GetSharedLinkPath(int iSharedLinkIndex);

int GetSharedLinkType(int iSharedLinkIndex);

QString GetSharedLinkURL(int iSharedLinkIndex);

int GetSharedLinkVisibility(int iSharedLinkIndex);

Remarks

This collection holds a list of shared links created by the current user.

Calling ListSharedLinks will populate this collection.

This property is not available at design time.

Data Type

CloudStorageDropboxSharedLink

SSLAcceptServerCert Property (Dropbox Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudStorageCertificate* val);

char* cloudstorage_dropbox_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_dropbox_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_dropbox_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_dropbox_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_dropbox_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_dropbox_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_dropbox_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_dropbox_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_dropbox_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_dropbox_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertusage(void* lpObj);

int cloudstorage_dropbox_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_dropbox_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_dropbox_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_dropbox_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_dropbox_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudStorageCertificate

SSLCert Property (Dropbox Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLCert();
int SetSSLCert(CloudStorageCertificate* val);

char* cloudstorage_dropbox_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_dropbox_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_dropbox_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_dropbox_getsslcertfingerprint(void* lpObj);

char* cloudstorage_dropbox_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslcertissuer(void* lpObj);

char* cloudstorage_dropbox_getsslcertprivatekey(void* lpObj);

int cloudstorage_dropbox_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_dropbox_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_dropbox_getsslcertpublickey(void* lpObj);

char* cloudstorage_dropbox_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_dropbox_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_dropbox_getsslcertserialnumber(void* lpObj);

char* cloudstorage_dropbox_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_dropbox_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_dropbox_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_dropbox_getsslcertstorepassword(void* lpObj);
int cloudstorage_dropbox_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_dropbox_getsslcertstoretype(void* lpObj);
int cloudstorage_dropbox_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_dropbox_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_dropbox_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_dropbox_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslcertusage(void* lpObj);

int cloudstorage_dropbox_getsslcertusageflags(void* lpObj);

char* cloudstorage_dropbox_getsslcertversion(void* lpObj);

char* cloudstorage_dropbox_getsslcertsubject(void* lpObj);
int cloudstorage_dropbox_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_dropbox_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_dropbox_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudStorageCertificate

SSLProvider Property (Dropbox Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudstorage_dropbox_getsslprovider(void* lpObj);
int cloudstorage_dropbox_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (Dropbox Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_dropbox_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_dropbox_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_dropbox_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_dropbox_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_dropbox_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslservercertissuer(void* lpObj);

char* cloudstorage_dropbox_getsslservercertprivatekey(void* lpObj);

int cloudstorage_dropbox_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_dropbox_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_dropbox_getsslservercertpublickey(void* lpObj);

char* cloudstorage_dropbox_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_dropbox_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_dropbox_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_dropbox_getsslservercertsignaturealgorithm(void* lpObj);

int cloudstorage_dropbox_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudstorage_dropbox_getsslservercertstorepassword(void* lpObj);

int cloudstorage_dropbox_getsslservercertstoretype(void* lpObj);

char* cloudstorage_dropbox_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_dropbox_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_dropbox_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_dropbox_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_dropbox_getsslservercertusage(void* lpObj);

int cloudstorage_dropbox_getsslservercertusageflags(void* lpObj);

char* cloudstorage_dropbox_getsslservercertversion(void* lpObj);

char* cloudstorage_dropbox_getsslservercertsubject(void* lpObj);

int cloudstorage_dropbox_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudStorageCertificate

StartByte Property (Dropbox Class)

The byte offset from which to start the upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 cloudstorage_dropbox_getstartbyte(void* lpObj);
int cloudstorage_dropbox_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file (or stream, when uploading) from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.

When uploading from a stream, the class will always seek forward in the stream if the value of StartByte is greater than 0 when UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Data Type

Long64

Timeout Property (Dropbox Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudstorage_dropbox_gettimeout(void* lpObj);
int cloudstorage_dropbox_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UploadSessionId Property (Dropbox Class)

The Id of the resumable upload session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUploadSessionId();
int SetUploadSessionId(const char* lpszUploadSessionId);

Unicode (Windows)
LPWSTR GetUploadSessionId();
INT SetUploadSessionId(LPCWSTR lpszUploadSessionId);

char* cloudstorage_dropbox_getuploadsessionid(void* lpObj);
int cloudstorage_dropbox_setuploadsessionid(void* lpObj, const char* lpszUploadSessionId);

QString GetUploadSessionId();
int SetUploadSessionId(QString qsUploadSessionId);

Default Value

""

Remarks

This property specifies the Id of the resumable upload session. This is populated by the class when UseResumableUpload is set to true and UploadFile is called to initiate the upload.

This must be set when resuming an upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

UseResumableUpload Property (Dropbox Class)

Whether to use resumable uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseResumableUpload();
int SetUseResumableUpload(int bUseResumableUpload);

Unicode (Windows)
BOOL GetUseResumableUpload();
INT SetUseResumableUpload(BOOL bUseResumableUpload);

int cloudstorage_dropbox_getuseresumableupload(void* lpObj);
int cloudstorage_dropbox_setuseresumableupload(void* lpObj, int bUseResumableUpload);

bool GetUseResumableUpload();
int SetUseResumableUpload(bool bUseResumableUpload);

Default Value

FALSE

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AddQueryParam Method (Dropbox Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudstorage_dropbox_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (Dropbox Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudstorage_dropbox_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CalcAuthorization Method (Dropbox Class)

Calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int cloudstorage_dropbox_calcauthorization(void* lpObj);

int CalcAuthorization();

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Dropbox Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudstorage_dropbox_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyResource Method (Dropbox Class)

Copies a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyResource(const char* lpszFromResource, const char* lpszToResourcePath);

Unicode (Windows)
LPWSTR CopyResource(LPCWSTR lpszFromResource, LPCWSTR lpszToResourcePath);

char* cloudstorage_dropbox_copyresource(void* lpObj, const char* lpszFromResource, const char* lpszToResourcePath);

QString CopyResource(const QString& qsFromResource, const QString& qsToResourcePath);

Remarks

This method copies the resource FromResource to a new path ToResourcePath, and returns the Id of the newly-copied resource.

FromResource must be a path, an Id-based relative path, or a resource Id. ToResourcePath must be a path or an Id-based relative path (it must always end with the desired name of the file/folder resource being copied).

The AllowCopySharedFolders configuration setting must be enabled before calling this method in order to copy shared resources.

The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateFolder Method (Dropbox Class)

Creates a new folder resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateFolder(const char* lpszNewFolderPath);

Unicode (Windows)
LPWSTR CreateFolder(LPCWSTR lpszNewFolderPath);

char* cloudstorage_dropbox_createfolder(void* lpObj, const char* lpszNewFolderPath);

QString CreateFolder(const QString& qsNewFolderPath);

Remarks

This method creates a new folder resource at the path NewFolderPath, and returns the Id of the newly-created folder resource.

NewFolderPath must be a folder path, or an Id-based relative folder path.

The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateLink Method (Dropbox Class)

Creates a shared link for a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateLink(const char* lpszResource);

Unicode (Windows)
LPWSTR CreateLink(LPCWSTR lpszResource);

char* cloudstorage_dropbox_createlink(void* lpObj, const char* lpszResource);

QString CreateLink(const QString& qsResource);

Remarks

This method creates a shared link for the resource specified by Resource and returns it.

Resource must be a path, an Id-based relative path, or a resource Id.

The CreateLinkExpiration, CreateLinkVisibility, and CreateLinkPassword configuration settings can be used to customize the settings used to create the shared link. // Create a password-protected shared link for the given file. dropbox.Config("CreateLinkPassword=password"); string sharingUrl = dropbox.CreateLink("/work_stuff/serious_business/best_cat_pictures.zip");

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DeleteResource Method (Dropbox Class)

Deletes a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteResource(const char* lpszResource);

Unicode (Windows)
INT DeleteResource(LPCWSTR lpszResource);

int cloudstorage_dropbox_deleteresource(void* lpObj, const char* lpszResource);

int DeleteResource(const QString& qsResource);

Remarks

This method deletes the resource specified by Resource.

Resource must be a path, an Id-based relative path, or a resource Id.

When deleting file resources, the IfRevision configuration setting can be set to a revision Id before calling this method. This will ensure that the server only deletes the file resource if its latest revision Id matches the one provided.

For Dropbox Business accounts, the PermanentlyDelete configuration setting can be enabled to delete resources permanently.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DownloadFile Method (Dropbox Class)

Downloads a file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DownloadFile(const char* lpszResource);

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszResource);

int cloudstorage_dropbox_downloadfile(void* lpObj, const char* lpszResource);

int DownloadFile(const QString& qsResource);

Remarks

This method downloads the file resource specified by Resource. If the AllowFolderDownloads configuration setting is enabled, it can also be used to download a folder resource as a ZIP file.

Resource must be a path, an Id-based relative path, a resource Id, or (for file resources only) a revision Id.

For file resources, the DownloadType property can be used to control whether this method downloads the file contents (default), a file preview, or a file thumbnail. The latter two options are only available for certain file types; refer to DownloadType for more information.

Note that certain file resources are "export-only"; when downloading such a file resource to a LocalFile, the class will append the file extension of export file format (if the name of the given LocalFile does not already end with said extension). Refer to the ExportExtension field for more information.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this: dropbox.LocalFile = "../MyFile.zip"; dropbox.DownloadFile(dropbox.Resources[0].Id);

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; dropbox.LocalFile = downloadFile; dropbox.DownloadFile(dropbox.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file dropbox.StartByte = new FileInfo(downloadFile).Length; dropbox.DownloadFile(dropbox.Resources[0].Id);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. dropbox.LocalFile = "../MyFile.zip"; dropbox.EncryptionPassword = "password"; dropbox.DownloadFile(dropbox.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file dropbox.StartByte = new FileInfo(dropbox.Config("DownloadTempFile")).Length; dropbox.DownloadFile(dropbox.Resources[0].Id);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAccountInfo Method (Dropbox Class)

Gets information about the current user's account and space usage.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccountInfo();

Unicode (Windows)
INT GetAccountInfo();

int cloudstorage_dropbox_getaccountinfo(void* lpObj);

int GetAccountInfo();

Remarks

This method gets information about the current user's account and space usage, populating the Account object property's fields. This method will also populate the following configuration settings, if necessary:

• AccountHomeNamespace
• AccountHomePath
• AccountRootNamespace

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetCurrentChangeMarker Method (Dropbox Class)

Gets the most current change marker.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCurrentChangeMarker(const char* lpszFolderResource);

Unicode (Windows)
INT GetCurrentChangeMarker(LPCWSTR lpszFolderResource);

int cloudstorage_dropbox_getcurrentchangemarker(void* lpObj, const char* lpszFolderResource);

int GetCurrentChangeMarker(const QString& qsFolderResource);

Remarks

This method populates NextChangeMarker with the most current change marker available. Like ListChanges, it may be limited to only changes within a certain FolderResource; and is sensitive to the IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings.

FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder).

Refer to ListChanges for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetResourceInfo Method (Dropbox Class)

Gets information about a specific resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceInfo(const char* lpszResource);

Unicode (Windows)
INT GetResourceInfo(LPCWSTR lpszResource);

int cloudstorage_dropbox_getresourceinfo(void* lpObj, const char* lpszResource);

int GetResourceInfo(const QString& qsResource);

Remarks

This method gets information about the resource specified by Resource.

Resource must be a path, an Id-based relative path, a resource Id, or (for file resources) a revision Id. Empty string (the root folder) is not supported.

Calling this method will fire the ResourceList event, and will populate the Resources properties with a single item (clearing any previously-held items in the process).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (Dropbox Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_dropbox_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListChanges Method (Dropbox Class)

Lists changes to resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListChanges(const char* lpszFolderResource);

Unicode (Windows)
INT ListChanges(LPCWSTR lpszFolderResource);

int cloudstorage_dropbox_listchanges(void* lpObj, const char* lpszFolderResource);

int ListChanges(const QString& qsFolderResource);

Remarks

This method lists changes to resources within the specified FolderResource.

FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder). The IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings may be used to further control the scope of the results.

Note that the values of FolderResource and the aforementioned configuration settings are all ignored if either ChangeMarker or NextChangeMarker is populated (the markers encode the values used originally).

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline state first in order to have a context onto which later changes can be applied.

To obtain a baseline state, ensure that both ChangeMarker and NextChangeMarker are empty, and then call ListChanges. Then follow the process described in the "General Usage" section (below) until ChangeMarker is empty, keeping in mind that the results being returned are not necessarily* changes, but rather the current state of resources within the scope determined by FolderResource, IncludeDeleted, IncludeMounted, and RecurseSubfolders.

*If any resources in the aforementioned scope are changed before all result pages of the baseline have been returned, Dropbox may append those change items to the end of the baseline's results. Refer to the "Usage Considerations" section (below) for more information.

Starting from the Latest State

For use-cases that don't require a baseline state (e.g., perhaps an application just displays a "ticker" with change information), call GetCurrentChangeMarker. This will populate NextChangeMarker immediately.

General Usage

When this method is called, it will use the change marker stored in either ChangeMarker or NextChangeMarker (only one can be populated at a time) to request the next page of changes. This method causes the ResourceList event to fire once for each change, and will also populate the Resources properties.

If there are still more changes available to list when this method returns, the ChangeMarker property will be populated. Continue to call this method until ChangeMarker is empty to accumulate all pages of results in the Resources properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.) Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

When NextChangeMarker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling ListChanges immediately after NextChangeMarker is populated will not return any further changes.)

Example of Getting a Baseline and then Listing Changes // Get the baseline state first. Dropbox dropbox = new Dropbox(); dropbox.ListChanges(""); do { // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). dropbox.ListChanges(""); } while (dropbox.ChangeMarker.Length > 0); for (int i = 0; i < dropbox.Resources.Count; i++) { // Apply the baseline state. } // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait at least 2 minutes for changes to occur. Assume something changes while we wait. dropbox.WaitForChanges(120); // (Note that this is a blocking call.) dropbox.ListChanges(""); do { dropbox.ListChanges(""); } while (dropbox.ChangeMarker.Length > 0); for (int i = 0; i < dropbox.Resources.Count; i++) { // Apply the changes. }

Usage Considerations

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListResources Method (Dropbox Class)

Lists resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListResources(const char* lpszFolderResource);

Unicode (Windows)
INT ListResources(LPCWSTR lpszFolderResource);

int cloudstorage_dropbox_listresources(void* lpObj, const char* lpszFolderResource);

int ListResources(const QString& qsFolderResource);

Remarks

This method lists resources within the specified FolderResource.

FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder). The IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings may be used to further control the scope of the results.

Note that the values of FolderResource and the aforementioned configuration settings are all ignored if ResourceMarker is populated (the marker encodes the values used originally).

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned. // ResourceList event handler. dropbox.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { dropbox.ListResources("/work_files/serious_business/cats"); for (int i = 0; i < dropbox.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(dropbox.ResourceMarker));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListRevisions Method (Dropbox Class)

Lists revisions for a file path or file resource Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListRevisions(const char* lpszFileResource);

Unicode (Windows)
INT ListRevisions(LPCWSTR lpszFileResource);

int cloudstorage_dropbox_listrevisions(void* lpObj, const char* lpszFileResource);

int ListRevisions(const QString& qsFileResource);

Remarks

This method lists revisions for a specific file path or for a specific file resource Id. This method is not supported for folder resources.

FileResource must be a file path, an Id-based relative file path, or a file resource Id.

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.

The MaxRevisionResults configuration setting controls the maximum number of results returned. (Note that unlike the class's other listing methods, the results returned by this method are never paged; MaxRevisionResults specifies the overall limit rather than the page size limit.)

Path-based vs. Id-based Revision Histories

When listing revisions, the server can return the revision history either by path or by Id. A path's revision history will include revisions for any and all files that have been located there; while an Id's revision history will only return revisions for the associated file resource (regardless of where it's been located over time).

By default, the class chooses which mode the server should use automatically each time ListRevisions is called based on the kind of resource identifier passed for the FileResource parameter. If a path (or an Id-based relative path) is provided, it chooses the path-based mode; and if a file resource Id is provided, it chooses the Id-based mode.

The ListRevisionsMode configuration setting can be used to explicitly control which revision listing mode the server should use. // ResourceList event handler. dropbox.OnResourceList += (s, e) => { Console.WriteLine(e.Name + ", Revision: " + e.Revision); }; dropbox.ListRevisions("/work_stuff/serious_business/best_cat_pictures.zip"); for (int i = 0; i < dropbox.Resources.Count; i++) { // Process resource revisions here. }

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListSharedLinks Method (Dropbox Class)

Lists shared links created by the current user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListSharedLinks(const char* lpszResource);

Unicode (Windows)
INT ListSharedLinks(LPCWSTR lpszResource);

int cloudstorage_dropbox_listsharedlinks(void* lpObj, const char* lpszResource);

int ListSharedLinks(const QString& qsResource);

Remarks

This method lists shared links created by the current user. If Resource is empty string, all of the user's shared links will be returned. If Resource is non-empty, the results will be limited to just shared links that provide access to the resource in question (direct links and links to any parent folders).

Resource must be a path, an Id-based relative path, a resource Id, or empty string.

Calling this method will fire the SharedLinkList event once for each shared link, and will also populate the SharedLinks properties.

If there are still more shared links available to list when this method returns, the SharedLinkMarker property will be populated. Continue to call this method until SharedLinkMarker is empty to accumulate all pages of results in the SharedLinks properties. // SharedLinkList event handler. dropbox.OnSharedLinkList += (s, e) => { Console.WriteLine(e.Name + ", URL: " + e.URL); }; // List all of the shared links created by the current user. do { dropbox.ListSharedLinks(""); for (int i = 0; i < dropbox.SharedLinks.Count; i++) { // Process shared links here. } } while (!string.IsNullOrEmpty(dropbox.SharedLinkMarker));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveResource Method (Dropbox Class)

Moves a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveResource(const char* lpszFromResource, const char* lpszToResourcePath);

Unicode (Windows)
INT MoveResource(LPCWSTR lpszFromResource, LPCWSTR lpszToResourcePath);

int cloudstorage_dropbox_moveresource(void* lpObj, const char* lpszFromResource, const char* lpszToResourcePath);

int MoveResource(const QString& qsFromResource, const QString& qsToResourcePath);

Remarks

This method moves the resource FromResource to a new path ToResourcePath.

FromResource must be a path, an Id-based relative path, or a resource Id. ToResourcePath must be a path or an Id-based relative path (it must always end with the name of the file/folder resource being moved).

The AllowOwnershipTransfers configuration setting must be enabled before calling this method if a move operation would result in the current user transferring their ownership to another user (or to a team).

The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Dropbox Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_dropbox_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RestoreResource Method (Dropbox Class)

Restores a given file resource revision.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* RestoreResource(const char* lpszRevision, const char* lpszToResourcePath);

Unicode (Windows)
LPWSTR RestoreResource(LPCWSTR lpszRevision, LPCWSTR lpszToResourcePath);

char* cloudstorage_dropbox_restoreresource(void* lpObj, const char* lpszRevision, const char* lpszToResourcePath);

QString RestoreResource(const QString& qsRevision, const QString& qsToResourcePath);

Remarks

This method restores a the specified Revision of a file resource, saving it to the given path ToResourcePath. Restoring a deleted file resource can also be done using this method as long as the revision Id is known (there's no way to obtain revision Ids for file resources which have already been deleted; this is a limitation of the Dropbox API).

Revision must be a revision Id. ToResourcePath must be a file path (and it must end with the desired name of the file resource being restored).

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

RevokeLink Method (Dropbox Class)

Revokes a shared link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RevokeLink(const char* lpszSharedLink);

Unicode (Windows)
INT RevokeLink(LPCWSTR lpszSharedLink);

int cloudstorage_dropbox_revokelink(void* lpObj, const char* lpszSharedLink);

int RevokeLink(const QString& qsSharedLink);

Remarks

This method revokes an existing shared link; SharedLink must be a shared link URL.

Keep in mind that a resource may still be accessible after revoking its shared link if shared links still exist for any of its parent folders. The ListSharedLinks method can be used to get a list of all existing links that provide access to any given resource.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Search Method (Dropbox Class)

Searches for resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Search(const char* lpszFolderResource, const char* lpszQuery);

Unicode (Windows)
INT Search(LPCWSTR lpszFolderResource, LPCWSTR lpszQuery);

int cloudstorage_dropbox_search(void* lpObj, const char* lpszFolderResource, const char* lpszQuery);

int Search(const QString& qsFolderResource, const QString& qsQuery);

Remarks

This method searches for resources matching Query within the specified FolderResource.

FolderResource must be a folder path, an Id-based, relative folder path, a folder resource Id, or empty string (in which case the current user's entire Dropbox is searched). The SearchCategories, SearchFileExtensions, SearchKind, and SearchNamesOnly properties may be used to further control the search options the server uses.

Calling this method will fire the ResourceList event once for each search result, and will also populate the Resources properties.

If there are still more search results available to list when this method returns, the SearchMarker property will be populated. Continue to call this method until SearchMarker is empty to accumulate all pages of results in the Resources properties.

The MaxSearchResults configuration setting can be used to control how many results are returned each time this method is called.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (Dropbox Class)

Sends a custom request to the Dropbox API.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszRequestPath, LPCWSTR lpszRequestBody);

int cloudstorage_dropbox_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsRequestPath, const QString& qsRequestBody);

Remarks

This method can be used to send arbitrary requests to the Dropbox API.

Valid values for HttpMethod are:

• GET
• POST (default if empty)

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Dropbox API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Dropbox API endpoint, https://api.dropboxapi.com/2.
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDownloadStream Method (Dropbox Class)

Sets the stream to which downloaded data will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(CloudStorageStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(CloudStorageStream* sDownloadStream);

int cloudstorage_dropbox_setdownloadstream(void* lpObj, CloudStorageStream* sDownloadStream);

int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetUploadStream Method (Dropbox Class)

Sets the stream from which data is read when uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(CloudStorageStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(CloudStorageStream* sUploadStream);

int cloudstorage_dropbox_setuploadstream(void* lpObj, CloudStorageStream* sUploadStream);

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UploadFile Method (Dropbox Class)

Uploads a file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* UploadFile(const char* lpszNewFileResource);

Unicode (Windows)
LPWSTR UploadFile(LPCWSTR lpszNewFileResource);

char* cloudstorage_dropbox_uploadfile(void* lpObj, const char* lpszNewFileResource);

QString UploadFile(const QString& qsNewFileResource);

Remarks

This method uploads a new file resource (or potentially updates or overwrites an existing one). The Id of the newly-created (or updated) file resource is returned.

NewFileResource must be a file path, an Id-based relative file path, or (only when updating/overwriting) a file resource Id.

Name Conflict Resolution

The class automatically chooses how the server should resolve name conflicts (which occur if the specified NewFileResource already exists) based on the current values of the IfRevision and RenameIfExists configuration settings and the Overwrite property. The following steps describe how the choice is made:

1. If the uploaded file data is identical to the contents of the existing file resource, the server will always ignore the upload attempt and return a successful response, regardless of what IfRevision, RenameIfExists, and Overwrite are currently set to. (This is a Dropbox server-side behavior that cannot be changed.)
2. Otherwise, if IfRevision is populated, then the existing file resource will have its contents updated as long as its latest revision Id matches the one held by IfRevision. If the revision Ids don't match, then RenameIfExists decides the outcome:
   • If RenameIfExists is true, then a new file resource is created with a unique name that contains "conflicted copy".
   • If RenameIfExists is false, then the upload fails.
3. Otherwise, if RenameIfExists is true, then a new file resource is created with a unique name.
4. Otherwise, if Overwrite is true, then the existing file resource is overwritten with a new one.
5. Otherwise, the upload fails.

If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

Dropbox offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. dropbox.LocalFile = "../MyFile.zip"; dropbox.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. UploadSessionId is populated with a resumable upload session Id identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that UploadSessionId and StartByte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset.

Note that if the upload is not resumed after some time the upload session will expire. dropbox.LocalFile = "../MyFile.zip"; dropbox.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. dropbox.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); dropbox.SetUploadStream(uploadStream); dropbox.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; dropbox.UploadFile("MyFile.zip");

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

WaitForChanges Method (Dropbox Class)

Waits a certain amount of time for changes to occur.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool WaitForChanges(int iTimeout);

Unicode (Windows)
INT WaitForChanges(INT iTimeout);

bool cloudstorage_dropbox_waitforchanges(void* lpObj, int iTimeout);

bool WaitForChanges(int iTimeout);

Remarks

This method blocks for Timeout seconds, waiting for changes to occur within the scope represented by the current NextChangeMarker (which must already be populated). If any changes occur, returns true; otherwise returns false.

Timeout must be a value between 30 and 480 seconds (inclusive). Note that Dropbox also adds 90 seconds of random jitter to this value. This method may return early if changes occur before the total timeout expires.

If this method returns true, use ListChanges to retrieve the changes.

Note that this method will automatically change the value of Timeout property as necessary when called; and will restore the original value before returning. // Get the baseline state first. Dropbox dropbox = new Dropbox(); dropbox.ListChanges(""); do { // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). dropbox.ListChanges(""); } while (dropbox.ChangeMarker.Length > 0); for (int i = 0; i < dropbox.Resources.Count; i++) { // Apply the baseline state. } // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait at least 2 minutes for changes to occur. Assume something changes while we wait. dropbox.WaitForChanges(120); // (Note that this is a blocking call.) dropbox.ListChanges(""); do { dropbox.ListChanges(""); } while (dropbox.ChangeMarker.Length > 0); for (int i = 0; i < dropbox.Resources.Count; i++) { // Apply the changes. }

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EndTransfer Event (Dropbox Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(DropboxEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} DropboxEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(DropboxEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} DropboxEndTransferEventParams;

#define EID_DROPBOX_ENDTRANSFER 1

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class DropboxEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(DropboxEndTransferEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireEndTransfer(DropboxEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (Dropbox Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(DropboxErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} DropboxErrorEventParams;


Unicode (Windows)
virtual INT FireError(DropboxErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} DropboxErrorEventParams;

#define EID_DROPBOX_ERROR 2

virtual INT CLOUDSTORAGE_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class DropboxErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(DropboxErrorEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireError(DropboxErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (Dropbox Class)

Fires after each fragment of a resumable upload is completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFragmentComplete(DropboxFragmentCompleteEventParams *e);

typedef struct {
  int FragmentNumber;
  int FragmentCount;
  int Interrupt;
  int reserved;
} DropboxFragmentCompleteEventParams;


Unicode (Windows)
virtual INT FireFragmentComplete(DropboxFragmentCompleteEventParams *e);

typedef struct {
  INT FragmentNumber;
  INT FragmentCount;
  BOOL Interrupt;
  INT reserved;
} DropboxFragmentCompleteEventParams;

#define EID_DROPBOX_FRAGMENTCOMPLETE 3

virtual INT CLOUDSTORAGE_CALL FireFragmentComplete(INT &iFragmentNumber, INT &iFragmentCount, BOOL &bInterrupt);

class DropboxFragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

  bool Interrupt();
  void SetInterrupt(bool bInterrupt);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FragmentComplete(DropboxFragmentCompleteEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireFragmentComplete(DropboxFragmentCompleteEventParams *e) {...}

Remarks

When UseResumableUpload is true and UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Header Event (Dropbox Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(DropboxHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} DropboxHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(DropboxHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} DropboxHeaderEventParams;

#define EID_DROPBOX_HEADER 4

virtual INT CLOUDSTORAGE_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class DropboxHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(DropboxHeaderEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireHeader(DropboxHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (Dropbox Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(DropboxLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} DropboxLogEventParams;


Unicode (Windows)
virtual INT FireLog(DropboxLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} DropboxLogEventParams;

#define EID_DROPBOX_LOG 5

virtual INT CLOUDSTORAGE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class DropboxLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(DropboxLogEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireLog(DropboxLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Progress Event (Dropbox Class)

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(DropboxProgressEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int64 TotalBytes;
  int PercentDone;
  int reserved;
} DropboxProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(DropboxProgressEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  LONG64 TotalBytes;
  INT PercentDone;
  INT reserved;
} DropboxProgressEventParams;

#define EID_DROPBOX_PROGRESS 6

virtual INT CLOUDSTORAGE_CALL FireProgress(INT &iDirection, LONG64 &lBytesTransferred, LONG64 &lTotalBytes, INT &iPercentDone);

class DropboxProgressEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  qint64 TotalBytes();

  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(DropboxProgressEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireProgress(DropboxProgressEventParams *e) {...}

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

ResourceList Event (Dropbox Class)

Fires once for each resource returned when listing resources, changes, or revisions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResourceList(DropboxResourceListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *Path;
  int ResourceType;
  const char *ModifiedTime;
  int64 Size;
  int AccessType;
  const char *Revision;
  const char *Hash;
  int Deleted;
  int reserved;
} DropboxResourceListEventParams;


Unicode (Windows)
virtual INT FireResourceList(DropboxResourceListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR Path;
  INT ResourceType;
  LPCWSTR ModifiedTime;
  LONG64 Size;
  INT AccessType;
  LPCWSTR Revision;
  LPCWSTR Hash;
  BOOL Deleted;
  INT reserved;
} DropboxResourceListEventParams;

#define EID_DROPBOX_RESOURCELIST 7

virtual INT CLOUDSTORAGE_CALL FireResourceList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszPath, INT &iResourceType, LPSTR &lpszModifiedTime, LONG64 &lSize, INT &iAccessType, LPSTR &lpszRevision, LPSTR &lpszHash, BOOL &bDeleted);

class DropboxResourceListEventParams {
public:
  const QString &Id();

  const QString &Name();

  const QString &Path();

  int ResourceType();

  const QString &ModifiedTime();

  qint64 Size();

  int AccessType();

  const QString &Revision();

  const QString &Hash();

  bool Deleted();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResourceList(DropboxResourceListEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireResourceList(DropboxResourceListEventParams *e) {...}

Remarks

This event fires once for each resource returned when ListResources, GetResourceInfo, Search, ListChanges, or ListRevisions is called.

Id is the Id of the resource.

Name is the name of the resource.

Path is the path of the resource.

ResourceType reflects the resource's type. Possible values are:

ModifiedTime reflects the last modified time of the file resource, as reported by the server. Not applicable for folder resources. Timestamps are formatted according to ISO 8601 and are always in UTC time.

Size is the size of the file resource, in bytes. Not applicable for folder resources.

AccessType reflects the type of access the current user has to the resource. Possible values are:

An access type of 2 (atLimited) still allows the user to call ListResources for a folder, but the results will be limited to the subset of resources within that folder that the user can actually access (including any further limited-access subfolders).

Revision is the revision Id of the file resource. Note applicable for folder resources.

Hash holds a hash of the file resource's content. Not applicable for folder resources.

Deleted indicates whether the resource has been deleted.

SharedLinkList Event (Dropbox Class)

Fires once for each shared link returned when listing shared links.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSharedLinkList(DropboxSharedLinkListEventParams *e);

typedef struct {
  const char *URL;
  const char *Name;
  const char *Id;
  const char *Path;
  int ResourceType;
  int Visibility;
  const char *Expires;
  int reserved;
} DropboxSharedLinkListEventParams;


Unicode (Windows)
virtual INT FireSharedLinkList(DropboxSharedLinkListEventParams *e);

typedef struct {
  LPCWSTR URL;
  LPCWSTR Name;
  LPCWSTR Id;
  LPCWSTR Path;
  INT ResourceType;
  INT Visibility;
  LPCWSTR Expires;
  INT reserved;
} DropboxSharedLinkListEventParams;

#define EID_DROPBOX_SHAREDLINKLIST 8

virtual INT CLOUDSTORAGE_CALL FireSharedLinkList(LPSTR &lpszURL, LPSTR &lpszName, LPSTR &lpszId, LPSTR &lpszPath, INT &iResourceType, INT &iVisibility, LPSTR &lpszExpires);

class DropboxSharedLinkListEventParams {
public:
  const QString &URL();

  const QString &Name();

  const QString &Id();

  const QString &Path();

  int ResourceType();

  int Visibility();

  const QString &Expires();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SharedLinkList(DropboxSharedLinkListEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireSharedLinkList(DropboxSharedLinkListEventParams *e) {...}

Remarks

This event fires once for each shared link returned when ListSharedLinks is called.

URL is the URL of the shared link.

Name is the name of the linked resource.

Id is Id of the linked resource.

Path is the path of the linked resource.

ResourceType reflects the linked resource's type. Possible values are:

Visibility reflects the visibility of the link. Possible values are:

Expires is the expiration timestamp of the link (or empty string, if the link doesn't expire). Timestamps are formatted according to ISO 8601 and are always in UTC time.

SSLServerAuthentication Event (Dropbox Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(DropboxSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} DropboxSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(DropboxSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} DropboxSSLServerAuthenticationEventParams;

#define EID_DROPBOX_SSLSERVERAUTHENTICATION 9

virtual INT CLOUDSTORAGE_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class DropboxSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(DropboxSSLServerAuthenticationEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireSSLServerAuthentication(DropboxSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Dropbox Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(DropboxSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} DropboxSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(DropboxSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} DropboxSSLStatusEventParams;

#define EID_DROPBOX_SSLSTATUS 10

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

class DropboxSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(DropboxSSLStatusEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireSSLStatus(DropboxSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (Dropbox Class)

This event fires when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(DropboxStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} DropboxStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(DropboxStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} DropboxStartTransferEventParams;

#define EID_DROPBOX_STARTTRANSFER 11

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class DropboxStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(DropboxStartTransferEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireStartTransfer(DropboxStartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (Dropbox Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(DropboxTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} DropboxTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(DropboxTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} DropboxTransferEventParams;

#define EID_DROPBOX_TRANSFER 12

virtual INT CLOUDSTORAGE_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class DropboxTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(DropboxTransferEventParams *e);

// Or, subclass Dropbox and override this emitter function.
virtual int FireTransfer(DropboxTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

CloudStorageCertificate (declared in cloudstorage.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

DropboxAccount Type

A Dropbox account's details and space usage information.

Syntax

CloudStorageDropboxAccount (declared in cloudstorage.h)

Remarks

This type represents a Dropbox account's details and space usage information.

Fields

Constructors

DropboxAccount()

DropboxResource Type

A Dropbox resource.

Syntax

CloudStorageDropboxResource (declared in cloudstorage.h)

Remarks

This type represents a Dropbox resource.

Fields