Dropbox Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudStorage_Dropbox

Procedural Interface

 cloudstorage_dropbox_open();
 cloudstorage_dropbox_close($res);
 cloudstorage_dropbox_register_callback($res, $id, $function);
 cloudstorage_dropbox_get_last_error($res);
 cloudstorage_dropbox_get_last_error_code($res);
 cloudstorage_dropbox_set($res, $id, $index, $value);
 cloudstorage_dropbox_get($res, $id, $index);
 cloudstorage_dropbox_do_addqueryparam($res, $name, $value);
 cloudstorage_dropbox_do_authorize($res);
 cloudstorage_dropbox_do_calcauthorization($res);
 cloudstorage_dropbox_do_config($res, $configurationstring);
 cloudstorage_dropbox_do_copyresource($res, $fromresource, $toresourcepath);
 cloudstorage_dropbox_do_createfolder($res, $newfolderpath);
 cloudstorage_dropbox_do_createlink($res, $resource);
 cloudstorage_dropbox_do_deleteresource($res, $resource);
 cloudstorage_dropbox_do_downloadfile($res, $resource);
 cloudstorage_dropbox_do_getaccountinfo($res);
 cloudstorage_dropbox_do_getcurrentchangemarker($res, $folderresource);
 cloudstorage_dropbox_do_getresourceinfo($res, $resource);
 cloudstorage_dropbox_do_interrupt($res);
 cloudstorage_dropbox_do_listchanges($res, $folderresource);
 cloudstorage_dropbox_do_listresources($res, $folderresource);
 cloudstorage_dropbox_do_listrevisions($res, $fileresource);
 cloudstorage_dropbox_do_listsharedlinks($res, $resource);
 cloudstorage_dropbox_do_moveresource($res, $fromresource, $toresourcepath);
 cloudstorage_dropbox_do_reset($res);
 cloudstorage_dropbox_do_restoreresource($res, $revision, $toresourcepath);
 cloudstorage_dropbox_do_revokelink($res, $sharedlink);
 cloudstorage_dropbox_do_search($res, $folderresource, $query);
 cloudstorage_dropbox_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);
 cloudstorage_dropbox_do_uploadfile($res, $newfileresource);
 cloudstorage_dropbox_do_waitforchanges($res, $timeout);

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* properties 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 = OAuthClientProfiles.cocpApplication; dropbox.OAuth.GrantType = OAuthGrantTypes.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 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:

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

AccountCountry Property (CloudStorage_Dropbox Class)

The country code of the account's user.

Object Oriented Interface

public function getAccountCountry();

Procedural Interface

cloudstorage_dropbox_get($res, 1 );

Default Value

''

Remarks

The country code of the account's user.

This property reflects the two-letter country code of the account's user, if available. Country codes are based on ISO 3166-1.

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

Data Type

String

AccountDisplayName Property (CloudStorage_Dropbox Class)

The display name of the account.

Object Oriented Interface

public function getAccountDisplayName();

Procedural Interface

cloudstorage_dropbox_get($res, 2 );

Default Value

''

Remarks

The display name of the account.

This property reflects the display name of the account itself.

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

Data Type

String

AccountEmail Property (CloudStorage_Dropbox Class)

The email address of the account.

Object Oriented Interface

public function getAccountEmail();

Procedural Interface

cloudstorage_dropbox_get($res, 3 );

Default Value

''

Remarks

The email address of the account.

This property reflects the email address associated with the account.

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

Data Type

String

AccountFirstName Property (CloudStorage_Dropbox Class)

The first name of the account's user.

Object Oriented Interface

public function getAccountFirstName();

Procedural Interface

cloudstorage_dropbox_get($res, 4 );

Default Value

''

Remarks

The first name of the account's user.

This property reflects the account user's first name.

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

Data Type

String

AccountId Property (CloudStorage_Dropbox Class)

The Id of the account.

Object Oriented Interface

public function getAccountId();

Procedural Interface

cloudstorage_dropbox_get($res, 5 );

Default Value

''

Remarks

The Id of the account.

This property reflects the Id of the account.

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

Data Type

String

AccountLastName Property (CloudStorage_Dropbox Class)

The last name of the account's user.

Object Oriented Interface

public function getAccountLastName();

Procedural Interface

cloudstorage_dropbox_get($res, 6 );

Default Value

''

Remarks

The last name of the account's user.

This property reflects the account user's last name.

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

Data Type

String

AccountTeamId Property (CloudStorage_Dropbox Class)

The Id of the account's team.

Object Oriented Interface

public function getAccountTeamId();

Procedural Interface

cloudstorage_dropbox_get($res, 7 );

Default Value

''

Remarks

The Id of the account's team.

This property reflects the Id of the account's team, if the account is paired to a team.

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

Data Type

String

AccountTeamMemberId Property (CloudStorage_Dropbox Class)

The team member Id of the account.

Object Oriented Interface

public function getAccountTeamMemberId();

Procedural Interface

cloudstorage_dropbox_get($res, 8 );

Default Value

''

Remarks

The team member Id of the account.

This property reflects the team member Id of the account, if the account is paired to a team.

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

Data Type

String

AccountTeamName Property (CloudStorage_Dropbox Class)

The name of the account's team.

Object Oriented Interface

public function getAccountTeamName();

Procedural Interface

cloudstorage_dropbox_get($res, 9 );

Default Value

''

Remarks

The name of the account's team.

This property reflects the name of the account's team, if the account is paired to a team.

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

Data Type

String

AccountTeamTotalSpace Property (CloudStorage_Dropbox Class)

The total amount of space allocated to the account's team.

Object Oriented Interface

public function getAccountTeamTotalSpace();

Procedural Interface

cloudstorage_dropbox_get($res, 10 );

Default Value

-1

Remarks

The total amount of space allocated to the account's team.

This property reflects the total amount of space, in bytes, allocated to the account's team, if the account is paired to a team.

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

Data Type

Long64

AccountTeamUsedSpace Property (CloudStorage_Dropbox Class)

The amount of space used by the account's team.

Object Oriented Interface

public function getAccountTeamUsedSpace();

Procedural Interface

cloudstorage_dropbox_get($res, 11 );

Default Value

-1

Remarks

The amount of space used by the account's team.

This property reflects the amount of space, in bytes, used by the account's team, if the account is paired to a team.

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

Data Type

Long64

AccountTotalSpace Property (CloudStorage_Dropbox Class)

The total amount of space allocated to the account.

Object Oriented Interface

public function getAccountTotalSpace();

Procedural Interface

cloudstorage_dropbox_get($res, 12 );

Default Value

-1

Remarks

The total amount of space allocated to the account.

This property reflects the total amount of space, in bytes, allocated to the account.

If the account is paired to a team, then the value of this property will either reflect the account's total space quota as defined by the team, or (if the account doesn't have a quota) the same value as the AccountTeamTotalSpace property.

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

Data Type

Long64

AccountType Property (CloudStorage_Dropbox Class)

The account's type.

Object Oriented Interface

public function getAccountType();

Procedural Interface

cloudstorage_dropbox_get($res, 13 );

Default Value

0

Remarks

The account's type.

This property reflects the account's type. Possible values are:

• 0 (atBasic)
• 1 (atPro)
• 2 (atBusiness)

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

Data Type

Integer

AccountUsedSpace Property (CloudStorage_Dropbox Class)

The amount of space used by the account.

Object Oriented Interface

public function getAccountUsedSpace();

Procedural Interface

cloudstorage_dropbox_get($res, 14 );

Default Value

-1

Remarks

The amount of space used by the account.

This property reflects the amount of space, in bytes, used by the account.

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

Data Type

Long64

Authorization Property (CloudStorage_Dropbox Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();


public function setAuthorization($value);

Procedural Interface

cloudstorage_dropbox_get($res, 15 );


cloudstorage_dropbox_set($res, 15, $value );

Default Value

''

Remarks

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

Bearer ACCESS_TOKEN

Data Type

String

ChangeMarker Property (CloudStorage_Dropbox Class)

A marker indicating what page of changes to return next.

Object Oriented Interface

public function getChangeMarker();


public function setChangeMarker($value);

Procedural Interface

cloudstorage_dropbox_get($res, 16 );


cloudstorage_dropbox_set($res, 16, $value );

Default Value

''

Remarks

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

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

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

DownloadType Property (CloudStorage_Dropbox Class)

The download type to use for file resources.

Object Oriented Interface

public function getDownloadType();


public function setDownloadType($value);

Procedural Interface

cloudstorage_dropbox_get($res, 17 );


cloudstorage_dropbox_set($res, 17, $value );

Default Value

0

Remarks

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

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

File previews are supported for the following file types:

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

This property is not available at design time.

Data Type

Integer

EncryptionAlgorithm Property (CloudStorage_Dropbox Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_dropbox_get($res, 18 );


cloudstorage_dropbox_set($res, 18, $value );

Default Value

0

Remarks

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

Data Type

Integer

EncryptionPassword Property (CloudStorage_Dropbox Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();


public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_dropbox_get($res, 19 );


cloudstorage_dropbox_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_Dropbox Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_dropbox_get($res, 20 );


cloudstorage_dropbox_set($res, 20, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_Dropbox Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudstorage_dropbox_get($res, 21 );


cloudstorage_dropbox_set($res, 21, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_Dropbox Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

cloudstorage_dropbox_get($res, 22 );


cloudstorage_dropbox_set($res, 22, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_Dropbox Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

cloudstorage_dropbox_get($res, 23 );


cloudstorage_dropbox_set($res, 23, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_Dropbox Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

cloudstorage_dropbox_get($res, 24 );


cloudstorage_dropbox_set($res, 24, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_Dropbox Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

cloudstorage_dropbox_get($res, 25 );


cloudstorage_dropbox_set($res, 25, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (CloudStorage_Dropbox Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_dropbox_get($res, 26 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_Dropbox Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

cloudstorage_dropbox_get($res, 27 );


cloudstorage_dropbox_set($res, 27, $value );

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.

Data Type

String

LocalHost Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

cloudstorage_dropbox_get($res, 28 );


cloudstorage_dropbox_set($res, 28, $value );

Default Value

''

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

NextChangeMarker Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getNextChangeMarker();


public function setNextChangeMarker($value);

Procedural Interface

cloudstorage_dropbox_get($res, 29 );


cloudstorage_dropbox_set($res, 29, $value );

Default Value

''

Remarks

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

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

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

Refer to ListChanges for more information.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudStorage_Dropbox Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();


public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_dropbox_get($res, 30 );


cloudstorage_dropbox_set($res, 30, $value );

Default Value

''

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudStorage_Dropbox Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();


public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_dropbox_get($res, 31 );


cloudstorage_dropbox_set($res, 31, $value );

Default Value

''

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudStorage_Dropbox Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();


public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_dropbox_get($res, 32 );


cloudstorage_dropbox_set($res, 32, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudStorage_Dropbox Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();


public function setOAuthClientId($value);

Procedural Interface

cloudstorage_dropbox_get($res, 33 );


cloudstorage_dropbox_set($res, 33, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudStorage_Dropbox Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();


public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_dropbox_get($res, 34 );


cloudstorage_dropbox_set($res, 34, $value );

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudStorage_Dropbox Class)

The secret value for the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientSecret();


public function setOAuthClientSecret($value);

Procedural Interface

cloudstorage_dropbox_get($res, 35 );


cloudstorage_dropbox_set($res, 35, $value );

Default Value

''

Remarks

The secret value for the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudStorage_Dropbox Class)

The OAuth grant type used to acquire an OAuth access token.

Object Oriented Interface

public function getOAuthGrantType();


public function setOAuthGrantType($value);

Procedural Interface

cloudstorage_dropbox_get($res, 36 );


cloudstorage_dropbox_set($res, 36, $value );

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudStorage_Dropbox Class)

Specifies the refresh token received from or sent to the authorization server.

Object Oriented Interface

public function getOAuthRefreshToken();


public function setOAuthRefreshToken($value);

Procedural Interface

cloudstorage_dropbox_get($res, 37 );


cloudstorage_dropbox_set($res, 37, $value );

Default Value

''

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (CloudStorage_Dropbox Class)

The URL where the user (browser) returns after authenticating.

Object Oriented Interface

public function getOAuthReturnURL();


public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_dropbox_get($res, 38 );


cloudstorage_dropbox_set($res, 38, $value );

Default Value

''

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudStorage_Dropbox Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();


public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_dropbox_get($res, 39 );


cloudstorage_dropbox_set($res, 39, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_Dropbox Class)

The URL of the token server used to obtain the access token.

Object Oriented Interface

public function getOAuthServerTokenURL();


public function setOAuthServerTokenURL($value);

Procedural Interface

cloudstorage_dropbox_get($res, 40 );


cloudstorage_dropbox_set($res, 40, $value );

Default Value

''

Remarks

The URL of the token server used to obtain the access token.

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudStorage_Dropbox Class)

The URL to which the user should be re-directed for authorization.

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_dropbox_get($res, 41 );

Default Value

''

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

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

Data Type

String

OtherHeaders Property (CloudStorage_Dropbox Class)

This property includes other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

cloudstorage_dropbox_get($res, 42 );


cloudstorage_dropbox_set($res, 42, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_Dropbox Class)

Whether to overwrite the local or remote file.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudstorage_dropbox_get($res, 43 );


cloudstorage_dropbox_set($res, 43, $value );

Default Value

false

Remarks

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

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

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_Dropbox Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_dropbox_get($res, 44 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (CloudStorage_Dropbox Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_dropbox_get($res, 45 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (CloudStorage_Dropbox Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_dropbox_get($res, 46 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ProxyAuthScheme Property (CloudStorage_Dropbox Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_dropbox_get($res, 47 );


cloudstorage_dropbox_set($res, 47, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_Dropbox Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_dropbox_get($res, 48 );


cloudstorage_dropbox_set($res, 48, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_Dropbox Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

cloudstorage_dropbox_get($res, 49 );


cloudstorage_dropbox_set($res, 49, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_Dropbox Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

cloudstorage_dropbox_get($res, 50 );


cloudstorage_dropbox_set($res, 50, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_Dropbox Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

cloudstorage_dropbox_get($res, 51 );


cloudstorage_dropbox_set($res, 51, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_Dropbox Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

cloudstorage_dropbox_get($res, 52 );


cloudstorage_dropbox_set($res, 52, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_Dropbox Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

cloudstorage_dropbox_get($res, 53 );


cloudstorage_dropbox_set($res, 53, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (CloudStorage_Dropbox Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();


public function setQueryParamCount($value);

Procedural Interface

cloudstorage_dropbox_get($res, 54 );


cloudstorage_dropbox_set($res, 54, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_Dropbox Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);


public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_dropbox_get($res, 55 , $queryparamindex);


cloudstorage_dropbox_set($res, 55, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_Dropbox Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);


public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_dropbox_get($res, 56 , $queryparamindex);


cloudstorage_dropbox_set($res, 56, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

ResourceData Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getResourceData();


public function setResourceData($value);

Procedural Interface

cloudstorage_dropbox_get($res, 57 );


cloudstorage_dropbox_set($res, 57, $value );

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.

Data Type

Binary String

ResourceMarker Property (CloudStorage_Dropbox Class)

A marker indicating what page of resources to return next.

Object Oriented Interface

public function getResourceMarker();


public function setResourceMarker($value);

Procedural Interface

cloudstorage_dropbox_get($res, 58 );


cloudstorage_dropbox_set($res, 58, $value );

Default Value

''

Remarks

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

Refer to ListResources for more information.

This property is not available at design time.

Data Type

String

ResourceCount Property (CloudStorage_Dropbox Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();


public function setResourceCount($value);

Procedural Interface

cloudstorage_dropbox_get($res, 59 );


cloudstorage_dropbox_set($res, 59, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceAccessType
• ResourceClientModifiedTime
• ResourceDeleted
• ResourceExportExtension
• ResourceHash
• ResourceId
• ResourceModifiedTime
• ResourceName
• ResourceParentShareId
• ResourcePath
• ResourceRevision
• ResourceShareId
• ResourceSize
• ResourceType

The array indices start at 0 and end at ResourceCount - 1.

This property is not available at design time.

Data Type

Integer

ResourceAccessType Property (CloudStorage_Dropbox Class)

The type of access the current user has to the resource.

Object Oriented Interface

public function getResourceAccessType($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 60 , $resourceindex);

Default Value

0

Remarks

The type of access the current user has to the resource.

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

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Integer

ResourceClientModifiedTime Property (CloudStorage_Dropbox Class)

The client-side last modified timestamp of the file resource.

Object Oriented Interface

public function getResourceClientModifiedTime($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 61 , $resourceindex);

Default Value

''

Remarks

The client-side last modified timestamp of the file resource.

This property holds the last modified timestamp of the file resource, as reported by a client. Timestamps are formatted according to ISO 8601 and are always in UTC time.

Not applicable for folder resources. May be empty or inaccurate for file resources if clients choose not to provide a value when uploading or updating the file contents.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceDeleted Property (CloudStorage_Dropbox Class)

Whether the resource has been deleted.

Object Oriented Interface

public function getResourceDeleted($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 62 , $resourceindex);

Default Value

false

Remarks

Whether the resource has been deleted.

This property reflects whether the resource has been deleted.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Boolean

ResourceExportExtension Property (CloudStorage_Dropbox Class)

The file extension of the file format that the file resource will be exported as.

Object Oriented Interface

public function getResourceExportExtension($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 63 , $resourceindex);

Default Value

''

Remarks

The file extension of the file format that the file resource will be exported as.

Some file resources are "export-only"; i.e., they're stored in Dropbox using a server-only file format, and get exported to a "normal" file format when DownloadFile is called. For export-only file resources, this property reflects the file extension of the export file format; it is empty for all other resources.

When downloading an export-only file resource to a LocalFile, the class will automatically append the file extension reflected by this property, if necessary.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceHash Property (CloudStorage_Dropbox Class)

A hash of the file resource's content.

Object Oriented Interface

public function getResourceHash($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 64 , $resourceindex);

Default Value

''

Remarks

A hash of the file resource's content.

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

Refer to the Dropbox API documentation for an explanation of how the server calculates file content hashes.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceId Property (CloudStorage_Dropbox Class)

The Id of the resource.

Object Oriented Interface

public function getResourceId($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 65 , $resourceindex);

Default Value

''

Remarks

The Id of the resource.

This property reflects the Id of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceModifiedTime Property (CloudStorage_Dropbox Class)

The last modified timestamp of the file resource.

Object Oriented Interface

public function getResourceModifiedTime($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 66 , $resourceindex);

Default Value

''

Remarks

The last modified timestamp of the file resource.

This property holds the last modified timestamp 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.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceName Property (CloudStorage_Dropbox Class)

The name of the resource.

Object Oriented Interface

public function getResourceName($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 67 , $resourceindex);

Default Value

''

Remarks

The name of the resource.

This property reflects the name of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceParentShareId Property (CloudStorage_Dropbox Class)

The shared folder Id of the resource's parent.

Object Oriented Interface

public function getResourceParentShareId($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 68 , $resourceindex);

Default Value

''

Remarks

The shared folder Id of the resource's parent.

This property reflects the shared folder Id of the resource's parent, if its parent is a shared folder.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourcePath Property (CloudStorage_Dropbox Class)

The path of the resource.

Object Oriented Interface

public function getResourcePath($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 69 , $resourceindex);

Default Value

''

Remarks

The path of the resource.

This property reflects the path of the resource.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceRevision Property (CloudStorage_Dropbox Class)

The revision Id of the file resource.

Object Oriented Interface

public function getResourceRevision($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 70 , $resourceindex);

Default Value

''

Remarks

The revision Id of the file resource.

This property reflects the revision Id of the file resource. Not applicable for folder resources.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceShareId Property (CloudStorage_Dropbox Class)

The shared folder Id of the folder resource.

Object Oriented Interface

public function getResourceShareId($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 71 , $resourceindex);

Default Value

''

Remarks

The shared folder Id of the folder resource.

This property reflects the shared folder Id of the folder resource, if the resource is a shared folder. Not applicable for file resources.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceSize Property (CloudStorage_Dropbox Class)

The size of the file resource.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 72 , $resourceindex);

Default Value

-1

Remarks

The size of the file resource.

This property holds the size of the file resource, in bytes. Not applicable for folder resources.

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Long64

ResourceType Property (CloudStorage_Dropbox Class)

The resource's type.

Object Oriented Interface

public function getResourceType($resourceindex);

Procedural Interface

cloudstorage_dropbox_get($res, 73 , $resourceindex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

The $resourceindex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Integer

SearchCategories Property (CloudStorage_Dropbox Class)

Resource categories to restrict the search to.

Object Oriented Interface

public function getSearchCategories();


public function setSearchCategories($value);

Procedural Interface

cloudstorage_dropbox_get($res, 74 );


cloudstorage_dropbox_set($res, 74, $value );

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

SearchFileExtensions Property (CloudStorage_Dropbox Class)

File extensions to restrict the search to.

Object Oriented Interface

public function getSearchFileExtensions();


public function setSearchFileExtensions($value);

Procedural Interface

cloudstorage_dropbox_get($res, 75 );


cloudstorage_dropbox_set($res, 75, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

SearchKind Property (CloudStorage_Dropbox Class)

The kind of resources to search for.

Object Oriented Interface

public function getSearchKind();


public function setSearchKind($value);

Procedural Interface

cloudstorage_dropbox_get($res, 76 );


cloudstorage_dropbox_set($res, 76, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

SearchMarker Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getSearchMarker();


public function setSearchMarker($value);

Procedural Interface

cloudstorage_dropbox_get($res, 77 );


cloudstorage_dropbox_set($res, 77, $value );

Default Value

''

Remarks

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

Refer to Search for more information.

This property is not available at design time.

Data Type

String

SearchNamesOnly Property (CloudStorage_Dropbox Class)

Whether to match against resource names only when searching.

Object Oriented Interface

public function getSearchNamesOnly();


public function setSearchNamesOnly($value);

Procedural Interface

cloudstorage_dropbox_get($res, 78 );


cloudstorage_dropbox_set($res, 78, $value );

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

SharedLinkMarker Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getSharedLinkMarker();


public function setSharedLinkMarker($value);

Procedural Interface

cloudstorage_dropbox_get($res, 79 );


cloudstorage_dropbox_set($res, 79, $value );

Default Value

''

Remarks

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

Refer to ListSharedLinks for more information

This property is not available at design time.

Data Type

String

SharedLinkCount Property (CloudStorage_Dropbox Class)

The number of records in the SharedLink arrays.

Object Oriented Interface

public function getSharedLinkCount();


public function setSharedLinkCount($value);

Procedural Interface

cloudstorage_dropbox_get($res, 80 );


cloudstorage_dropbox_set($res, 80, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SharedLinkCanRevoke
• SharedLinkExpires
• SharedLinkId
• SharedLinkName
• SharedLinkPath
• SharedLinkType
• SharedLinkURL
• SharedLinkVisibility

The array indices start at 0 and end at SharedLinkCount - 1.

This property is not available at design time.

Data Type

Integer

SharedLinkCanRevoke Property (CloudStorage_Dropbox Class)

Whether the current user has permission to revoke the link.

Object Oriented Interface

public function getSharedLinkCanRevoke($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 81 , $sharedlinkindex);

Default Value

false

Remarks

Whether the current user has permission to revoke the link.

This property indicates whether the current user has permission to revoke the link.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

Boolean

SharedLinkExpires Property (CloudStorage_Dropbox Class)

The expiration timestamp of the link.

Object Oriented Interface

public function getSharedLinkExpires($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 82 , $sharedlinkindex);

Default Value

''

Remarks

The expiration timestamp of the link.

This property holds 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.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

String

SharedLinkId Property (CloudStorage_Dropbox Class)

The Id of the linked resource.

Object Oriented Interface

public function getSharedLinkId($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 83 , $sharedlinkindex);

Default Value

''

Remarks

The Id of the linked resource.

This property reflects the Id of the linked resource.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

String

SharedLinkName Property (CloudStorage_Dropbox Class)

The name of the linked resource.

Object Oriented Interface

public function getSharedLinkName($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 84 , $sharedlinkindex);

Default Value

''

Remarks

The name of the linked resource.

This property reflects the name of the linked resource.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

String

SharedLinkPath Property (CloudStorage_Dropbox Class)

The path of the linked resource.

Object Oriented Interface

public function getSharedLinkPath($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 85 , $sharedlinkindex);

Default Value

''

Remarks

The path of the linked resource.

This property reflects the path of the linked resource.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

String

SharedLinkType Property (CloudStorage_Dropbox Class)

The linked resource's type.

Object Oriented Interface

public function getSharedLinkType($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 86 , $sharedlinkindex);

Default Value

0

Remarks

The linked resource's type.

This property indicates whether the linked resource is a folder or a file. Possible values are:

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

Integer

SharedLinkURL Property (CloudStorage_Dropbox Class)

The URL of the link.

Object Oriented Interface

public function getSharedLinkURL($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 87 , $sharedlinkindex);

Default Value

''

Remarks

The URL of the link.

This property reflects the URL of the link.

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

String

SharedLinkVisibility Property (CloudStorage_Dropbox Class)

The visibility of the link.

Object Oriented Interface

public function getSharedLinkVisibility($sharedlinkindex);

Procedural Interface

cloudstorage_dropbox_get($res, 88 , $sharedlinkindex);

Default Value

0

Remarks

The visibility of the link.

This property reflects the visibility of the link. Possible values are:

The $sharedlinkindex parameter specifies the index of the item in the array. The size of the array is controlled by the SharedLinkCount property.

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

Data Type

Integer

SSLAcceptServerCertEncoded Property (CloudStorage_Dropbox Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_dropbox_get($res, 90 );


cloudstorage_dropbox_set($res, 90, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudStorage_Dropbox Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_dropbox_get($res, 118 );


cloudstorage_dropbox_set($res, 118, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudStorage_Dropbox Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

cloudstorage_dropbox_get($res, 134 );


cloudstorage_dropbox_set($res, 134, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_Dropbox Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_dropbox_get($res, 135 );


cloudstorage_dropbox_set($res, 135, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_Dropbox Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_dropbox_get($res, 136 );


cloudstorage_dropbox_set($res, 136, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (CloudStorage_Dropbox Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_dropbox_get($res, 137 );


cloudstorage_dropbox_set($res, 137, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (CloudStorage_Dropbox Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudstorage_dropbox_get($res, 145 );


cloudstorage_dropbox_set($res, 145, $value );

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:

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

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

Data Type

Integer

SSLServerCertEncoded Property (CloudStorage_Dropbox Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_dropbox_get($res, 147 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

StartByte Property (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

cloudstorage_dropbox_get($res, 174 );


cloudstorage_dropbox_set($res, 174, $value );

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.

Data Type

Long64

Timeout Property (CloudStorage_Dropbox Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudstorage_dropbox_get($res, 175 );


cloudstorage_dropbox_set($res, 175, $value );

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UploadSessionId Property (CloudStorage_Dropbox Class)

The Id of the resumable upload session.

Object Oriented Interface

public function getUploadSessionId();


public function setUploadSessionId($value);

Procedural Interface

cloudstorage_dropbox_get($res, 176 );


cloudstorage_dropbox_set($res, 176, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

UseResumableUpload Property (CloudStorage_Dropbox Class)

Whether to use resumable uploads.

Object Oriented Interface

public function getUseResumableUpload();


public function setUseResumableUpload($value);

Procedural Interface

cloudstorage_dropbox_get($res, 177 );


cloudstorage_dropbox_set($res, 177, $value );

Default Value

false

Remarks

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

Refer to UploadFile for more information.

This property is not available at design time.

Data Type

Boolean

AddQueryParam Method (CloudStorage_Dropbox Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_dropbox_do_addqueryparam($res, $name, $value);

Remarks

This method is used to add a query parameter to the QueryaParam* 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.

Authorize Method (CloudStorage_Dropbox Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_dropbox_do_authorize($res);

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

For more information, see the introduction section.

CalcAuthorization Method (CloudStorage_Dropbox Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_dropbox_do_calcauthorization($res);

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.

Config Method (CloudStorage_Dropbox Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_dropbox_do_config($res, $configurationstring);

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.

CopyResource Method (CloudStorage_Dropbox Class)

Copies a resource.

Object Oriented Interface

public function doCopyResource($fromresource, $toresourcepath);

Procedural Interface

cloudstorage_dropbox_do_copyresource($res, $fromresource, $toresourcepath);

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.

CreateFolder Method (CloudStorage_Dropbox Class)

Creates a new folder resource.

Object Oriented Interface

public function doCreateFolder($newfolderpath);

Procedural Interface

cloudstorage_dropbox_do_createfolder($res, $newfolderpath);

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.

CreateLink Method (CloudStorage_Dropbox Class)

Creates a shared link for a resource.

Object Oriented Interface

public function doCreateLink($resource);

Procedural Interface

cloudstorage_dropbox_do_createlink($res, $resource);

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

DeleteResource Method (CloudStorage_Dropbox Class)

Deletes a resource.

Object Oriented Interface

public function doDeleteResource($resource);

Procedural Interface

cloudstorage_dropbox_do_deleteresource($res, $resource);

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.

DownloadFile Method (CloudStorage_Dropbox Class)

Downloads a file resource.

Object Oriented Interface

public function doDownloadFile($resource);

Procedural Interface

cloudstorage_dropbox_do_downloadfile($res, $resource);

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

GetAccountInfo Method (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function doGetAccountInfo();

Procedural Interface

cloudstorage_dropbox_do_getaccountinfo($res);

Remarks

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

• AccountHomeNamespace
• AccountHomePath
• AccountRootNamespace

GetCurrentChangeMarker Method (CloudStorage_Dropbox Class)

Gets the most current change marker.

Object Oriented Interface

public function doGetCurrentChangeMarker($folderresource);

Procedural Interface

cloudstorage_dropbox_do_getcurrentchangemarker($res, $folderresource);

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.

GetResourceInfo Method (CloudStorage_Dropbox Class)

Gets information about a specific resource.

Object Oriented Interface

public function doGetResourceInfo($resource);

Procedural Interface

cloudstorage_dropbox_do_getresourceinfo($res, $resource);

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 Resource* properties with a single item (clearing any previously-held items in the process).

Interrupt Method (CloudStorage_Dropbox Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_dropbox_do_interrupt($res);

Remarks

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

ListChanges Method (CloudStorage_Dropbox Class)

Lists changes to resources.

Object Oriented Interface

public function doListChanges($folderresource);

Procedural Interface

cloudstorage_dropbox_do_listchanges($res, $folderresource);

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 Resource* 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 Resource* properties. (Once there aren't any more changes available to list, the NextChangeMarker property will be populated instead.)

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

ListResources Method (CloudStorage_Dropbox Class)

Lists resources.

Object Oriented Interface

public function doListResources($folderresource);

Procedural Interface

cloudstorage_dropbox_do_listresources($res, $folderresource);

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

ListRevisions Method (CloudStorage_Dropbox Class)

Lists revisions for a file path or file resource Id.

Object Oriented Interface

public function doListRevisions($fileresource);

Procedural Interface

cloudstorage_dropbox_do_listrevisions($res, $fileresource);

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

ListSharedLinks Method (CloudStorage_Dropbox Class)

Lists shared links created by the current user.

Object Oriented Interface

public function doListSharedLinks($resource);

Procedural Interface

cloudstorage_dropbox_do_listsharedlinks($res, $resource);

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

MoveResource Method (CloudStorage_Dropbox Class)

Moves a resource.

Object Oriented Interface

public function doMoveResource($fromresource, $toresourcepath);

Procedural Interface

cloudstorage_dropbox_do_moveresource($res, $fromresource, $toresourcepath);

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.

Reset Method (CloudStorage_Dropbox Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_dropbox_do_reset($res);

Remarks

This method resets the class to its initial state.

RestoreResource Method (CloudStorage_Dropbox Class)

Restores a given file resource revision.

Object Oriented Interface

public function doRestoreResource($revision, $toresourcepath);

Procedural Interface

cloudstorage_dropbox_do_restoreresource($res, $revision, $toresourcepath);

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

RevokeLink Method (CloudStorage_Dropbox Class)

Revokes a shared link.

Object Oriented Interface

public function doRevokeLink($sharedlink);

Procedural Interface

cloudstorage_dropbox_do_revokelink($res, $sharedlink);

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.

Search Method (CloudStorage_Dropbox Class)

Searches for resources.

Object Oriented Interface

public function doSearch($folderresource, $query);

Procedural Interface

cloudstorage_dropbox_do_search($res, $folderresource, $query);

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

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

SendCustomRequest Method (CloudStorage_Dropbox Class)

Sends a custom request to the Dropbox API.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $requestpath, $requestbody);

Procedural Interface

cloudstorage_dropbox_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);

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 QueryParam* 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 ParsedHeader* 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.

UploadFile Method (CloudStorage_Dropbox Class)

Uploads a file resource.

Object Oriented Interface

public function doUploadFile($newfileresource);

Procedural Interface

cloudstorage_dropbox_do_uploadfile($res, $newfileresource);

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

WaitForChanges Method (CloudStorage_Dropbox Class)

Waits a certain amount of time for changes to occur.

Object Oriented Interface

public function doWaitForChanges($timeout);

Procedural Interface

cloudstorage_dropbox_do_waitforchanges($res, $timeout);

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

EndTransfer Event (CloudStorage_Dropbox Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 1, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

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

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

Error Event (CloudStorage_Dropbox Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 2, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

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

FragmentComplete Event (CloudStorage_Dropbox Class)

Fires after each fragment of a resumable upload is completed.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 3, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

Remarks

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

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

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

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

Header Event (CloudStorage_Dropbox Class)

This event is fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 4, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

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

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

Log Event (CloudStorage_Dropbox Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Progress Event (CloudStorage_Dropbox Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 6, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

Remarks

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

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

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

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

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

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

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

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

ResourceList Event (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function fireResourceList($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 7, array($this, 'fireResourceList'));

Parameter List

 'id'
 'name'
 'path'
 'resourcetype'
 'modifiedtime'
 'size'
 'accesstype'
 'revision'
 'hash'
 'deleted'

Remarks

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

Id is the Id of the resource.

Name is the name of the resource.

Path is the path of the resource.

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

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

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

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

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

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

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

Deleted indicates whether the resource has been deleted.

SharedLinkList Event (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function fireSharedLinkList($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 8, array($this, 'fireSharedLinkList'));

Parameter List

 'url'
 'name'
 'id'
 'path'
 'resourcetype'
 'visibility'
 'expires'

Remarks

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

URL is the URL of the shared link.

Name is the name of the linked resource.

Id is Id of the linked resource.

Path is the path of the linked resource.

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

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

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

SSLServerAuthentication Event (CloudStorage_Dropbox Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 9, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

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

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

SSLStatus Event (CloudStorage_Dropbox Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 10, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (CloudStorage_Dropbox Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 11, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

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

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

Transfer Event (CloudStorage_Dropbox Class)

This event is fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_dropbox_register_callback($res, 12, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

Config Settings (Dropbox Class)

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

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings