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

cloudstorage.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 OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType property. 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 OAuthGrantType property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode property, 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 OAuthRefreshToken property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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 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 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). 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");

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.

Dropbox.Account Property

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

Syntax

getAccount(): DropboxAccount;

Default Value

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.

Dropbox.Authorization Property

OAuth 2.0 Authorization Token.

Syntax

getAuthorization(): string;
setAuthorization(authorization: string): void;

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

Dropbox.ChangeMarker Property

A marker indicating what page of changes to return next.

Syntax

getChangeMarker(): string;
setChangeMarker(changeMarker: string): void;

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.

Dropbox.DownloadType Property

The download type to use for file resources.

Syntax

getDownloadType(): DropboxDownloadTypes;
setDownloadType(downloadType: DropboxDownloadTypes): void;

enum DropboxDownloadTypes {
  ddtFileContent,
  ddtFileThumbnail,
  ddtFilePreview
}

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.

Dropbox.EncryptionAlgorithm Property

The encryption algorithm.

Syntax

getEncryptionAlgorithm(): DropboxEncryptionAlgorithms;
setEncryptionAlgorithm(encryptionAlgorithm: DropboxEncryptionAlgorithms): void;

enum DropboxEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

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:

Dropbox.EncryptionPassword Property

The encryption password.

Syntax

getEncryptionPassword(): string;
setEncryptionPassword(encryptionPassword: string): void;

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.

Dropbox.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

Dropbox.Idle Property

The current status of the class.

Syntax

isIdle(): boolean;

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.

Dropbox.LocalFile Property

The location of the local file.

Syntax

getLocalFile(): string;
setLocalFile(localFile: string): void;

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.

Dropbox.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

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.

Dropbox.NextChangeMarker Property

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

Syntax

getNextChangeMarker(): string;
setNextChangeMarker(nextChangeMarker: string): void;

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.

Dropbox.OAuth Property

This property holds the OAuth Settings.

Syntax

getOAuth(): OAuthSettings;

Default Value

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.

Dropbox.OtherHeaders Property

Other headers as determined by the user (optional).

Syntax

getOtherHeaders(): string;
setOtherHeaders(otherHeaders: string): void;

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 .

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.

Dropbox.Overwrite Property

Whether to overwrite the local or remote file.

Syntax

isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;

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).

Dropbox.ParsedHeaders Property

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

Syntax

getParsedHeaders(): HeaderList;

Default Value

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.

Dropbox.Proxy Property

A set of properties related to proxy access.

Syntax

getProxy(): Proxy;
setProxy(proxy: Proxy): void;

Default Value

Remarks

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

Dropbox.QueryParams Property

Additional query parameters to be included in the request.

Syntax

getQueryParams(): QueryParamList;
setQueryParams(queryParams: QueryParamList): void;

Default Value

Remarks

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

Dropbox.ResourceData Property

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

Syntax

getResourceData(): Uint8Array;
setResourceData(resourceData: Uint8Array): void;

Default Value

""

Remarks

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

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

This property is not available at design time.

Dropbox.ResourceMarker Property

A marker indicating what page of resources to return next.

Syntax

getResourceMarker(): string;
setResourceMarker(resourceMarker: string): void;

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.

Dropbox.Resources Property

A collection of resources.

Syntax

getResources(): DropboxResourceList;
setResources(resources: DropboxResourceList): void;

Default Value

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.

Dropbox.SearchCategories Property

Resource categories to restrict the search to.

Syntax

getSearchCategories(): string;
setSearchCategories(searchCategories: string): void;

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.

Dropbox.SearchFileExtensions Property

File extensions to restrict the search to.

Syntax

getSearchFileExtensions(): string;
setSearchFileExtensions(searchFileExtensions: string): void;

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.

Dropbox.SearchKind Property

The kind of resources to search for.

Syntax

getSearchKind(): DropboxSearchKinds;
setSearchKind(searchKind: DropboxSearchKinds): void;

enum DropboxSearchKinds {
  dskActive,
  dskDeleted
}

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.

Dropbox.SearchMarker Property

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

Syntax

getSearchMarker(): string;
setSearchMarker(searchMarker: string): void;

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.

Dropbox.SearchNamesOnly Property

Whether to match against resource names only when searching.

Syntax

isSearchNamesOnly(): boolean;
setSearchNamesOnly(searchNamesOnly: boolean): void;

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.

Dropbox.SharedLinkMarker Property

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

Syntax

getSharedLinkMarker(): string;
setSharedLinkMarker(sharedLinkMarker: string): void;

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.

Dropbox.SharedLinks Property

A collection of shared links created by the current user.

Syntax

getSharedLinks(): DropboxSharedLinkList;
setSharedLinks(sharedLinks: DropboxSharedLinkList): void;

Default Value

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.

Dropbox.SSLAcceptServerCert Property

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

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

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.

Dropbox.SSLCert Property

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

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

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 field to the encoded certificate. To select a certificate, use the store and subject fields.

Dropbox.SSLProvider Property

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

Syntax

getSSLProvider(): DropboxSSLProviders;
setSSLProvider(SSLProvider: DropboxSSLProviders): void;

enum DropboxSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

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, the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The internal provider is not support at this time.

Dropbox.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

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.

Dropbox.StartByte Property

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

Syntax

getStartByte(): number;
setStartByte(startByte: number): void;

Default Value

0

Remarks

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

This property is not available at design time.

Dropbox.Timeout Property

The timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 .

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.

Dropbox.UploadSessionId Property

The Id of the resumable upload session.

Syntax

getUploadSessionId(): string;
setUploadSessionId(uploadSessionId: string): void;

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.

Dropbox.UseResumableUpload Property

Whether to use resumable uploads.

Syntax

isUseResumableUpload(): boolean;
setUseResumableUpload(useResumableUpload: boolean): void;

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.

Dropbox.addQueryParam Method

Adds a query parameter to the QueryParams properties.

Syntax

async dropbox.addQueryParam(name : string, value : string): Promise<void>

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.

Dropbox.authorize Method

Get the authorization string required to access the protected resource.

Syntax

async dropbox.authorize(): Promise<void>

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 OAuthClientProfile property and the OAuthGrantType property. 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.

Dropbox.calcAuthorization Method

Calculates the Authorization header based on provided credentials.

Syntax

async dropbox.calcAuthorization(): Promise<void>

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.

Dropbox.config Method

Sets or retrieves a configuration setting.

Syntax

async dropbox.config(configurationString : string): Promise<string>

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.

Dropbox.copyResource Method

Copies a resource.

Syntax

async dropbox.copyResource(fromResource : string, toResourcePath : string): Promise<string>

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.

Dropbox.createFolder Method

Creates a new folder resource.

Syntax

async dropbox.createFolder(newFolderPath : string): Promise<string>

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.

Dropbox.createLink Method

Creates a shared link for a resource.

Syntax

async dropbox.createLink(resource : string): Promise<string>

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");

Dropbox.deleteResource Method

Deletes a resource.

Syntax

async dropbox.deleteResource(resource : string): Promise<void>

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.

Dropbox.downloadFile Method

Downloads a file resource.

Syntax

async dropbox.downloadFile(resource : string): Promise<void>

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 ResourcesExportExtension property for more information.

If 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);

Dropbox.getAccountInfo Method

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

Syntax

async dropbox.getAccountInfo(): Promise<void>

Remarks

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

• AccountHomeNamespace
• AccountHomePath
• AccountRootNamespace

Dropbox.getCurrentChangeMarker Method

Gets the most current change marker.

Syntax

async dropbox.getCurrentChangeMarker(folderResource : string): Promise<void>

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.

Dropbox.getResourceInfo Method

Gets information about a specific resource.

Syntax

async dropbox.getResourceInfo(resource : string): Promise<void>

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).

Dropbox.interrupt Method

This method interrupts the current method.

Syntax

async dropbox.interrupt(): Promise<void>

Remarks

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

Dropbox.listChanges Method

Lists changes to resources.

Syntax

async dropbox.listChanges(folderResource : string): Promise<void>

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

Dropbox.listResources Method

Lists resources.

Syntax

async dropbox.listResources(folderResource : string): Promise<void>

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));

Dropbox.listRevisions Method

Lists revisions for a file path or file resource Id.

Syntax

async dropbox.listRevisions(fileResource : string): Promise<void>

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. }

Dropbox.listSharedLinks Method

Lists shared links created by the current user.

Syntax

async dropbox.listSharedLinks(resource : string): Promise<void>

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));

Dropbox.moveResource Method

Moves a resource.

Syntax

async dropbox.moveResource(fromResource : string, toResourcePath : string): Promise<void>

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.

Dropbox.reset Method

Resets the class to its initial state.

Syntax

async dropbox.reset(): Promise<void>

Remarks

This method resets the class to its initial state.

Dropbox.restoreResource Method

Restores a given file resource revision.

Syntax

async dropbox.restoreResource(revision : string, toResourcePath : string): Promise<string>

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).

Dropbox.revokeLink Method

Revokes a shared link.

Syntax

async dropbox.revokeLink(sharedLink : string): Promise<void>

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.

Dropbox.search Method

Searches for resources.

Syntax

async dropbox.search(folderResource : string, query : string): Promise<void>

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.

Dropbox.sendCustomRequest Method

Sends a custom request to the Dropbox API.

Syntax

async dropbox.sendCustomRequest(httpMethod : string, requestPath : string, requestBody : string): Promise<void>

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 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.

Dropbox.uploadFile Method

Uploads a file resource.

Syntax

async dropbox.uploadFile(newFileResource : string): Promise<string>

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 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). 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");

Dropbox.waitForChanges Method

Waits a certain amount of time for changes to occur.

Syntax

async dropbox.waitForChanges(timeout : number): Promise<boolean>

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. }

Dropbox.EndTransfer Event

This event fires when a document finishes transferring.

Syntax

dropbox.on('EndTransfer', listener: (e: {readonly direction: number}) => void )

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.

Dropbox.Error Event

Fired when information is available about errors during data delivery.

Syntax

dropbox.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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.

Dropbox.FragmentComplete Event

Fires after each fragment of a resumable upload is completed.

Syntax

dropbox.on('FragmentComplete', listener: (e: {readonly fragmentNumber: number, readonly fragmentCount: number, interrupt: boolean}) => void )

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.

Dropbox.Header Event

Fired every time a header line comes in.

Syntax

dropbox.on('Header', listener: (e: {readonly field: string, readonly value: string}) => void )

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).

Dropbox.Log Event

Fired once for each log message.

Syntax

dropbox.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

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"

Dropbox.Progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

dropbox.on('Progress', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly totalBytes: number, readonly percentDone: number}) => void )

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.

Dropbox.ResourceList Event

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

Syntax

dropbox.on('ResourceList', listener: (e: {readonly id: string, readonly name: string, readonly path: string, readonly resourceType: number, readonly modifiedTime: string, readonly size: number, readonly accessType: number, readonly revision: string, readonly hash: string, readonly deleted: boolean}) => void )

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.

Dropbox.SharedLinkList Event

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

Syntax

dropbox.on('SharedLinkList', listener: (e: {readonly URL: string, readonly name: string, readonly id: string, readonly path: string, readonly resourceType: number, readonly visibility: number, readonly expires: string}) => void )

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.

Dropbox.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

dropbox.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

Dropbox.SSLStatus Event

Fired when secure connection progress messages are available.

Syntax

dropbox.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

Dropbox.StartTransfer Event

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

Syntax

dropbox.on('StartTransfer', listener: (e: {readonly direction: number}) => void )

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.

Dropbox.Transfer Event

Fired while a document transfers (delivers document).

Syntax

dropbox.on('Transfer', listener: (e: {readonly direction: number, readonly bytesTransferred: number, readonly percentDone: number, readonly text: string, readonly textB: Uint8Array}) => void )

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.

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

public Certificate();

public Certificate(String certificateFile);

public Certificate(byte[] encoded);

public Certificate(int storeType, String store, String storePassword, String subject);

public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, String store, String storePassword, byte[] encoded);

public Certificate(int storeType, byte[] store, String storePassword, String subject);

public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);

public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);

DropboxAccount Type

A Dropbox account's details and space usage information.

Remarks

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

Fields

Constructors

public DropboxAccount();

DropboxResource Type

A Dropbox resource.

Remarks

This type represents a Dropbox resource.

Fields

Constructors

public DropboxResource();

DropboxSharedLink Type

A Dropbox shared link.

Remarks

This type represents a Dropbox shared link.

Fields

Constructors

public DropboxSharedLink();

Firewall Type

The firewall the class will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

Constructors

public Firewall();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public Header();

public Header(String field, String value);

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

Used to set give the class the necessary information needed to complete OAuth authentication.

Fields

Constructors

public OAuthSettings();

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

Constructors

public Proxy();

public Proxy(String server, int port);

public Proxy(String server, int port, String user, String password);

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

public QueryParam();

public QueryParam(String name, String value);

Config Settings (class cloudstorage.dropbox)

Dropbox Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (class cloudstorage.dropbox)

Common Errors

HTTP Errors