CloudFiles Class

Properties   Methods   Events   Config Settings   Errors  

The CloudFiles class provides an easy way to upload, download, and manage files and folders with multiple service providers.

Class Name

CloudStorage_CloudFiles

Procedural Interface

 cloudstorage_cloudfiles_open();
 cloudstorage_cloudfiles_close($res);
 cloudstorage_cloudfiles_register_callback($res, $id, $function);
 cloudstorage_cloudfiles_get_last_error($res);
 cloudstorage_cloudfiles_get_last_error_code($res);
 cloudstorage_cloudfiles_set($res, $id, $index, $value);
 cloudstorage_cloudfiles_get($res, $id, $index);
 cloudstorage_cloudfiles_do_config($res, $configurationstring);
 cloudstorage_cloudfiles_do_deletefile($res, $filename);
 cloudstorage_cloudfiles_do_download($res);
 cloudstorage_cloudfiles_do_interrupt($res);
 cloudstorage_cloudfiles_do_listdirectory($res);
 cloudstorage_cloudfiles_do_makedirectory($res, $newdir);
 cloudstorage_cloudfiles_do_removedirectory($res, $dirname);
 cloudstorage_cloudfiles_do_renamefile($res, $newname);
 cloudstorage_cloudfiles_do_reset($res);
 cloudstorage_cloudfiles_do_upload($res);

Remarks

The CloudFiles class provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this class:

• Amazon S3
• Azure Blob
• Azure File
• Backblaze B2
• Box.com
• Digital Ocean Spaces
• Dropbox
• Google Cloud Storage
• Google Drive
• Hadoop DFS
• IBM Cloud Object Storage
• Linode Object Storage
• Microsoft OneDrive
• Wasabi

The class supports simple file and folder management as well as encryption. Capabilities include uploading and downloading files, strong encryption support, creating folders, and more.

To begin, first create an account and register your application. Consult the documentation of the individual service provider for instructions on this process.

Authentication

The following providers use OAuth 2.0 for authentication:

• Box.com
• Dropbox
• Google Cloud Storage*
• Google Drive
• Microsoft OneDrive

Use the OAuth class included in the toolkit, or any other OAuth implementation to perform authentication and retrieve an authorization string. Once you've obtained an authorization string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

To authenticate with the remaining providers, set the Account* properties shown in the table below:

*Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) set the Authorization property and the AccountProjectId property. To authenticate with an access and secret key, set the AccountAccessKey and AccountSecretKey properties instead.

Selecting a Provider

To specify the provider simply set ServiceProvider. This tells the class to which service requests will be made.

Listing Files and Folders

ListDirectory lists files and folder the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties. cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: component.RemoteFile = "*.txt" component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location. If LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, 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. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download();

Uploading Files

The Upload method is used to upload files.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example: //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload()

Additional Functionality

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

• Encrypt and decrypt files using EncryptionAlgorithm and EncryptionPassword.
• DeleteFile provides a way to delete files.
• MakeDirectory and RemoveDirectory support creating and deleting folders.
• RenameFile allows renaming of existing files on the server.
• 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.

AccountAccessKey Property (CloudStorage_CloudFiles Class)

A storage service provider access key.

Object Oriented Interface

public function getAccountAccessKey();


public function setAccountAccessKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 1 );


cloudstorage_cloudfiles_set($res, 1, $value );

Default Value

''

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

• cspAmazonS3 (0)
• cspAzureBlob (6)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
• cspAzureFile (11)
• cspIBMStorage (13)
• cspLinode (14)

Data Type

String

AccountAccount Property (CloudStorage_CloudFiles Class)

A storage service provider account string.

Object Oriented Interface

public function getAccountAccount();


public function setAccountAccount($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 2 );


cloudstorage_cloudfiles_set($res, 2, $value );

Default Value

''

Remarks

A storage service provider account string.

This property specifies the account string to use for authentication. It must be populated when using one of these storage service providers:

• cspAzureBlob (6)
• cspAzureFile (11)

Data Type

String

AccountApplicationKey Property (CloudStorage_CloudFiles Class)

A storage service provider application key.

Object Oriented Interface

public function getAccountApplicationKey();


public function setAccountApplicationKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 3 );


cloudstorage_cloudfiles_set($res, 3, $value );

Default Value

''

Remarks

A storage service provider application key.

This property specifies the application key to use for authentication. It must be populated when using one of these storage service providers:

• cspBackblazeB2 (12)

Data Type

String

AccountApplicationKeyId Property (CloudStorage_CloudFiles Class)

A storage service provider application key Id.

Object Oriented Interface

public function getAccountApplicationKeyId();


public function setAccountApplicationKeyId($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 4 );


cloudstorage_cloudfiles_set($res, 4, $value );

Default Value

''

Remarks

A storage service provider application key Id.

This property specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers:

• cspBackblazeB2 (12)

Data Type

String

AccountAuthMechanism Property (CloudStorage_CloudFiles Class)

The HTTP authentication scheme to use (for storage service providers that support multiple).

Object Oriented Interface

public function getAccountAuthMechanism();


public function setAccountAuthMechanism($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 5 );


cloudstorage_cloudfiles_set($res, 5, $value );

Default Value

0

Remarks

The HTTP authentication scheme to use (for storage service providers that support multiple).

For storage service providers that support more than one HTTP authentication scheme, this property specifies which should be used. This property is only relevant for the following storage service providers:

• cspHadoopDFS (10)

Usage

Possible values for this property are:

When set to camSimple (1), the value of the AccountUser property is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the cspHadoopDFS (10) storage service provider.)

When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the AccountUser and AccountPassword properties will be used to perform Basic, NTLM, or Negotiate authentication.

When set to camOAuth (5), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

Data Type

Integer

AccountHadoopURL Property (CloudStorage_CloudFiles Class)

The URL of the Hadoop WebHDFS server.

Object Oriented Interface

public function getAccountHadoopURL();


public function setAccountHadoopURL($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 6 );


cloudstorage_cloudfiles_set($res, 6, $value );

Default Value

''

Remarks

The URL of the Hadoop WebHDFS server.

This property specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to cspHadoopDFS (10).

A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The class will automatically append /webhdfs/v1 when making requests (if necessary).

The class automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured).

Data Type

String

AccountPassword Property (CloudStorage_CloudFiles Class)

A storage service provider password.

Object Oriented Interface

public function getAccountPassword();


public function setAccountPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 7 );


cloudstorage_cloudfiles_set($res, 7, $value );

Default Value

''

Remarks

A storage service provider password.

This property specifies the password to use for authentication. It must be populated when using one of these storage service providers:

• cspHadoopDFS (10) (only required for certain AccountAuthMechanism options)

Data Type

String

AccountProjectId Property (CloudStorage_CloudFiles Class)

A Google Cloud Platform project Id string.

Object Oriented Interface

public function getAccountProjectId();


public function setAccountProjectId($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 8 );


cloudstorage_cloudfiles_set($res, 8, $value );

Default Value

''

Remarks

A Google Cloud Platform project Id string.

This property specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the Authorization property is populated) with one of these storage service providers:

• cspGoogleStorage (9)

Note that the above providers will fall back to using an AccountAccessKey and AccountSecretKey for authentication if either this property or the Authorization property is empty.

Data Type

String

AccountSecretKey Property (CloudStorage_CloudFiles Class)

A storage service provider access key.

Object Oriented Interface

public function getAccountSecretKey();


public function setAccountSecretKey($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 9 );


cloudstorage_cloudfiles_set($res, 9, $value );

Default Value

''

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

• cspAmazonS3 (0)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
• cspIBMStorage (13)
• cspLinode (14)

Data Type

String

AccountUser Property (CloudStorage_CloudFiles Class)

A storage service provider user name.

Object Oriented Interface

public function getAccountUser();


public function setAccountUser($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 10 );


cloudstorage_cloudfiles_set($res, 10, $value );

Default Value

''

Remarks

A storage service provider user name.

This property specifies the user name to use for authentication. It must be populated when using one of these storage service providers:

• cspHadoopDFS (10) (only required for certain AccountAuthMechanism options)

Data Type

String

Authorization Property (CloudStorage_CloudFiles Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();


public function setAuthorization($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 11 );


cloudstorage_cloudfiles_set($res, 11, $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

DirListCount Property (CloudStorage_CloudFiles Class)

The number of records in the DirList arrays.

Object Oriented Interface

public function getDirListCount();

Procedural Interface

cloudstorage_cloudfiles_get($res, 12 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir

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

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

Data Type

Integer

DirListFileName Property (CloudStorage_CloudFiles Class)

This property holds the name of the file or folder.

Object Oriented Interface

public function getDirListFileName($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 13 , $entryindex);

Default Value

''

Remarks

This property holds the name of the file or folder.

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

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

Data Type

String

DirListFileSize Property (CloudStorage_CloudFiles Class)

This property holds the size of the file in bytes.

Object Oriented Interface

public function getDirListFileSize($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 14 , $entryindex);

Default Value

0

Remarks

This property holds the size of the file in bytes. This is also applicable to folders for depending on the ServiceProvider.

The table below summarizes the applicability of this value on a per-provider basis:

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

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

Data Type

Long64

DirListFileTime Property (CloudStorage_CloudFiles Class)

This property holds the modified date of the file.

Object Oriented Interface

public function getDirListFileTime($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 15 , $entryindex);

Default Value

''

Remarks

This property holds the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat.

Note: Modified times are not applicable to directories for the following providers:

• cspAmazonS3 (0)
• cspDropbox (2)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9)
• cspBackblazeB2 (12)
• cspIBMStorage (13)
• cspLinode (14)

Additionally, the following providers do not return modified times at all:

• cspAzureFile (11)

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

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

Data Type

String

DirListIsDir Property (CloudStorage_CloudFiles Class)

This property specifies whether the entry is a directory.

Object Oriented Interface

public function getDirListIsDir($entryindex);

Procedural Interface

cloudstorage_cloudfiles_get($res, 16 , $entryindex);

Default Value

false

Remarks

This property specifies whether the entry is a directory. If false the entry is a file.

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

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

Data Type

Boolean

EncryptionAlgorithm Property (CloudStorage_CloudFiles Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 17 );


cloudstorage_cloudfiles_set($res, 17, $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_CloudFiles Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();


public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 18 );


cloudstorage_cloudfiles_set($res, 18, $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_CloudFiles 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_cloudfiles_get($res, 19 );


cloudstorage_cloudfiles_set($res, 19, $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_CloudFiles Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 20 );


cloudstorage_cloudfiles_set($res, 20, $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_CloudFiles 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_cloudfiles_get($res, 21 );


cloudstorage_cloudfiles_set($res, 21, $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_CloudFiles 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_cloudfiles_get($res, 22 );


cloudstorage_cloudfiles_set($res, 22, $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_CloudFiles 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_cloudfiles_get($res, 23 );


cloudstorage_cloudfiles_set($res, 23, $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_CloudFiles 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_cloudfiles_get($res, 24 );


cloudstorage_cloudfiles_set($res, 24, $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_CloudFiles Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_cloudfiles_get($res, 25 );

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_CloudFiles Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 26 );


cloudstorage_cloudfiles_set($res, 26, $value );

Default Value

''

Remarks

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

Data Type

String

LocalHost Property (CloudStorage_CloudFiles 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_cloudfiles_get($res, 27 );


cloudstorage_cloudfiles_set($res, 27, $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

Overwrite Property (CloudStorage_CloudFiles Class)

Whether to overwrite the local or remote file.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 28 );


cloudstorage_cloudfiles_set($res, 28, $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.

Data Type

Boolean

ProxyAuthScheme Property (CloudStorage_CloudFiles 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_cloudfiles_get($res, 29 );


cloudstorage_cloudfiles_set($res, 29, $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_CloudFiles 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_cloudfiles_get($res, 30 );


cloudstorage_cloudfiles_set($res, 30, $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_CloudFiles 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_cloudfiles_get($res, 31 );


cloudstorage_cloudfiles_set($res, 31, $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_CloudFiles 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_cloudfiles_get($res, 32 );


cloudstorage_cloudfiles_set($res, 32, $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_CloudFiles 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_cloudfiles_get($res, 33 );


cloudstorage_cloudfiles_set($res, 33, $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_CloudFiles 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_cloudfiles_get($res, 34 );


cloudstorage_cloudfiles_set($res, 34, $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_CloudFiles 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_cloudfiles_get($res, 35 );


cloudstorage_cloudfiles_set($res, 35, $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

RemoteFile Property (CloudStorage_CloudFiles Class)

The name of the remote file.

Object Oriented Interface

public function getRemoteFile();


public function setRemoteFile($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 36 );


cloudstorage_cloudfiles_set($res, 36, $value );

Default Value

''

Remarks

This property contains the name of the remote file to upload or download. This value is either an absolute or relative path based on RemotePath.

Example (Setting RemoteFile) component.LocalFile = "C:\\test.txt"; component.RemoteFile = "test.txt"; component.Upload(); component.LocalFile = "C:\\test.txt"; component.RemoteFile = "/MyFolder/SubFolder/file.txt"; component.Upload(); Note: This property will also act as a file mask when calling ListDirectory.

Example (Using RemoteFile as a file mask): component.RemoteFile = "*.txt" component.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemotePath Property (CloudStorage_CloudFiles Class)

The current path on the server.

Object Oriented Interface

public function getRemotePath();


public function setRemotePath($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 37 );


cloudstorage_cloudfiles_set($res, 37, $value );

Default Value

''

Remarks

This property shows the current working directory on the server. It can also be used to change the working directory by setting an absolute or relative path.

If the path begins with a "/" it is considered an absolute path.

If the first two characters of the path are ".." this indicates a change to the parent directory.

Example (Changing Directory) component.RemotePath = "/MyFolder/Child"; //absolute component.RemotePath = "GrandChild"; //relative, change to a sub-folder of the current directory component.RemotePath = "../.."; //relative, use ".." to navigate to parent folders

Data Type

String

ServiceProvider Property (CloudStorage_CloudFiles Class)

The storage service provider.

Object Oriented Interface

public function getServiceProvider();


public function setServiceProvider($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 38 );


cloudstorage_cloudfiles_set($res, 38, $value );

Default Value

0

Remarks

This property specifies the storage service provider which will be used. It is important to note that the ServiceProvider property must be set before setting any configuration settings through the Config method.

Possible values are:

• cspAmazonS3 (0) (default): Amazon S3
• cspBox (1): Box.com
• cspDropbox (2): Dropbox
• cspGoogleDrive (3): Google Drive
• cspOneDrive (4): Microsoft OneDrive
• cspAzureBlob (6): Azure Blob
• cspWasabi (7): Wasabi
• cspDigitalOcean (8): Digital Ocean Spaces
• cspGoogleStorage (9): Google Cloud Storage
• cspHadoopDFS (10): Hadoop DFS
• cspAzureFile (11): Azure File
• cspBackblazeB2 (12): Backblaze B2
• cspIBMStorage (13): IBM Cloud Object Storage
• cspLinode (14): Linode Object Storage

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (CloudStorage_CloudFiles Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 40 );


cloudstorage_cloudfiles_set($res, 40, $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_CloudFiles Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 68 );


cloudstorage_cloudfiles_set($res, 68, $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_CloudFiles 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_cloudfiles_get($res, 84 );


cloudstorage_cloudfiles_set($res, 84, $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_CloudFiles 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_cloudfiles_get($res, 85 );


cloudstorage_cloudfiles_set($res, 85, $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_CloudFiles Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 86 );


cloudstorage_cloudfiles_set($res, 86, $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_CloudFiles 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_cloudfiles_get($res, 87 );


cloudstorage_cloudfiles_set($res, 87, $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_CloudFiles Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 95 );


cloudstorage_cloudfiles_set($res, 95, $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_CloudFiles Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_cloudfiles_get($res, 97 );

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_CloudFiles Class)

The byte offset from which to start download.

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 124 );


cloudstorage_cloudfiles_set($res, 124, $value );

Default Value

0

Remarks

This property may be set to resume a download. This specifies the offset in the file from which to resume. See Download for details about resuming downloads.

Note: Resuming uploads is not currently supported.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_CloudFiles Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudstorage_cloudfiles_get($res, 125 );


cloudstorage_cloudfiles_set($res, 125, $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

Config Method (CloudStorage_CloudFiles Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

DeleteFile Method (CloudStorage_CloudFiles Class)

Remove a file specified by FileName from the server.

Object Oriented Interface

public function doDeleteFile($filename);

Procedural Interface

cloudstorage_cloudfiles_do_deletefile($res, $filename);

Remarks

This method deletes the files specified by the FileName parameter from the server. FileName may be either an absolute path, or a path relative to RemotePath.

Download Method (CloudStorage_CloudFiles Class)

Download the specified file.

Object Oriented Interface

public function doDownload();

Procedural Interface

cloudstorage_cloudfiles_do_download($res);

Remarks

This method downloads the specified file. Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location. If LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, 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. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download();

Interrupt Method (CloudStorage_CloudFiles Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_cloudfiles_do_interrupt($res);

Remarks

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

ListDirectory Method (CloudStorage_CloudFiles Class)

Lists the current directory specified by RemotePath on the server.

Object Oriented Interface

public function doListDirectory();

Procedural Interface

cloudstorage_cloudfiles_do_listdirectory($res);

Remarks

This method is used to list the directory specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties. cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: component.RemoteFile = "*.txt" component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

MakeDirectory Method (CloudStorage_CloudFiles Class)

Creates a directory on the server.

Object Oriented Interface

public function doMakeDirectory($newdir);

Procedural Interface

cloudstorage_cloudfiles_do_makedirectory($res, $newdir);

Remarks

This method is used to create a directory. The parameter NewDir specifies the name of the directory. NewDir may be either an absolute path, or a path relative to RemotePath.

Note: After creating a directory RemoteFile will be updated with the newly created directory name.

RemoveDirectory Method (CloudStorage_CloudFiles Class)

Remove the specified directory.

Object Oriented Interface

public function doRemoveDirectory($dirname);

Procedural Interface

cloudstorage_cloudfiles_do_removedirectory($res, $dirname);

Remarks

This method removes the directory specified by the DirName parameter. DirName may be either an absolute path, or a path relative to RemotePath.

Note: The directory and all of its contents will be deleted when calling this method. (With the exception of non-root-level directories for the cspAzureFile (11) ServiceProvider; such directories can only be deleted if they are empty.)

RenameFile Method (CloudStorage_CloudFiles Class)

Renames the file.

Object Oriented Interface

public function doRenameFile($newname);

Procedural Interface

cloudstorage_cloudfiles_do_renamefile($res, $newname);

Remarks

This method renames an existing file on the server. The NewName parameter specifies the new name of the file. cloudfiles.RemotePath = "/MyFolder"; cloudfiles.RemoteFile = "file.txt"; cloudfiles.RenameFile("newfile.txt");

Note: RenameFile is not supported when ServiceProvider is set to one of the following:

• cspAmazonS3 (0)
• cspAzureBlob (6)
• cspDigitalOcean (8)
• cspGoogleStorage (9)
• cspAzureFile (11)
• cspBackblazeB2 (12)
• cspIBMStorage (13)
• cspLinode (14)

Reset Method (CloudStorage_CloudFiles Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_cloudfiles_do_reset($res);

Remarks

This method resets the class to its initial state.

Upload Method (CloudStorage_CloudFiles Class)

Uploads the file specified by LocalFile to the server.

Object Oriented Interface

public function doUpload();

Procedural Interface

cloudstorage_cloudfiles_do_upload($res);

Remarks

This method uploads the local file specified by LocalFile to the remote file specified by RemoteFile.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example: //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload()

DirList Event (CloudStorage_CloudFiles Class)

Fired when a directory entry is received.

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 1, array($this, 'fireDirList'));

Parameter List

 'filename'
 'isdir'
 'filesize'
 'filetime'

Remarks

This event fires once for each entry returned when ListDirectory is called.

FileName holds the name of the file or folder.

IsDir is true for directories and false for files.

FileSize is the size of the file in bytes. For some providers this also applies directories and will return the size of all files and folders within the directory.

The table below summarizes the applicability of this value on a per-provider basis:

FileTime is the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat.

Note: Modified times are not applicable to directories for the following providers:

• cspAmazonS3 (0)
• cspDropbox (2)
• cspWasabi (7)
• cspDigitalOcean (8)
• cspGoogleStorage (9)
• cspBackblazeB2 (12)
• cspIBMStorage (13)
• cspLinode (14)

Additionally, the following providers do not return modified times at all:

• cspAzureFile (11)

EndTransfer Event (CloudStorage_CloudFiles Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 2, 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_CloudFiles Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 3, 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.

Log Event (CloudStorage_CloudFiles Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 4, 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_CloudFiles Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 5, 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.

SSLServerAuthentication Event (CloudStorage_CloudFiles Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 6, 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_CloudFiles Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 7, 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_CloudFiles Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 8, 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_CloudFiles Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_cloudfiles_register_callback($res, 9, 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 (CloudFiles Class)

CloudFiles 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

Trappable Errors (CloudFiles Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors