IPWorks Cloud 2020 JavaScript Edition

Questions / Feedback?

Dropbox Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

ipworkscloud.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 supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. 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).
The documentation for this class's methods will always note which of the above options are acceptable for each applicable method parameter.

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 Resource* 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 Resource* properties.

// 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:

Property List


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

AccountDetails about the current user's account and space usage.
AuthorizationOAuth 2.0 Authorization Token.
ChangeMarkerA marker indicating what page of changes to return next.
DownloadTypeThe download type to use for file resources.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NextChangeMarkerA marker indicating what page of changes to return in the future.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether to overwrite the local or remote file.
ParsedHeadersCollection of headers returned from the last request.
ProxyA set of properties related to proxy access.
QueryParamsAdditional query parameters to be included in the request.
ResourceDataThe data that was downloaded, or that should be uploaded.
ResourceMarkerA marker indicating what page of resources to return next.
ResourcesA collection of resources.
SearchCategoriesResource categories to restrict the search to.
SearchFileExtensionsFile extensions to restrict the search to.
SearchKindThe kind of resources to search for.
SearchMarkerA marker indicating what page of search results to return next.
SearchNamesOnlyWhether to match against resource names only when searching.
SharedLinkMarkerA marker indicating what page of shared links to return next.
SharedLinksA collection of shared links created by the current user.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the class.
UploadSessionIdThe Id of the resumable upload session.
UseResumableUploadWhether to use resumable uploads.

Method List


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

AddQueryParamAdds a query parameter to the QueryParams properties.
ConfigSets or retrieves a configuration setting.
CopyResourceCopies a resource.
CreateFolderCreates a new folder resource.
CreateLinkCreates a shared link for a resource.
DeleteResourceDeletes a resource.
DownloadFileDownloads a file resource.
GetAccountInfoGets information about the current user's account and space usage.
GetCurrentChangeMarkerGets the most current change marker.
GetResourceInfoGets information about a specific resource.
InterruptInterrupt the current method.
ListChangesLists changes to resources.
ListResourcesLists resources.
ListRevisionsLists revisions for a file path or file resource Id.
ListSharedLinksLists shared links created by the current user.
MoveResourceMoves a resource.
ResetResets the class to its initial state.
RestoreResourceRestores a given file resource revision.
RevokeLinkRevokes a shared link.
SearchSearches for resources.
SendCustomRequestSends a custom request to the Dropbox API.
UploadFileUploads a file resource.
WaitForChangesWaits a certain amount of time for changes to occur.

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.

EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteFires after each fragment of a resumable upload is completed.
HeaderFired every time a header line comes in.
LogFires once for each log message.
ProgressFires during an upload or download to indicate transfer progress.
ResourceListFires once for each resource returned when listing resources, changes, or revisions.
SharedLinkListFires once for each shared link returned when listing shared links.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).

Configuration Settings


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

AccountHomeNamespaceThe current user's home namespace Id.
AccountHomePathThe path for the current user's home directory, if their account is part of a team.
AccountRootNamespaceThe current user's root namespace Id.
AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
AllowCopySharedFoldersWhether to allow the copying of shared folders or their contents.
AllowFolderDownloadsWhether to allow folder downloading.
AllowOwnershipTransfersWhether to allow move operations that would result in ownership transfers.
ClientModifiedTimeThe client-side last modified time.
CreateLinkExpirationThe expiration date to assign to the link.
CreateLinkPasswordThe password to protect the link with.
CreateLinkVisibilityThe visibility to create links with.
DateFormatThe format to use for date and time.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
FragmentSizeThe fragment size.
IfRevisionA revision Id, used to modify certain requests.
IncludeDeletedWhether deleted resources should be included in the results.
IncludeMountedWhether to include resources in mounted folders in the results.
ListRevisionsModeControls the revision listing mode that the server should use.
MaxResultsLimits the number of resource and change results.
MaxRevisionResultsLimits the number of revision results.
MaxSearchResultsLimits the number of search results.
MuteFileUploadsWhether the server should suppress file change notifications.
PermanentlyDeleteWhether resources should be permanently deleted (Dropbox Business only).
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
RecurseSubfoldersWhether to recursively list all resources within the specified folder.
RenameIfExistsWhether to rename newly-created resources in the event of a name conflict.
TempPathThe path to the directory where temporary files are created.
ThumbnailFormatThe image format thumbnails should be downloaded in.
ThumbnailModeThe mode the server should use to create thumbnails.
ThumbnailSizeThe thumbnail output size.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLAcceptAnyServerCertWhether to trust any certificate presented by the server.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 JavaScript Edition - Version 20.0 [Build 8265]