Box Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

CloudStorage_Box

Procedural Interface

 cloudstorage_box_open();
 cloudstorage_box_close($res);
 cloudstorage_box_register_callback($res, $id, $function);
 cloudstorage_box_get_last_error($res);
 cloudstorage_box_get_last_error_code($res);
 cloudstorage_box_set($res, $id, $index, $value);
 cloudstorage_box_get($res, $id, $index);
 cloudstorage_box_do_abortupload($res);
 cloudstorage_box_do_addqueryparam($res, $name, $value);
 cloudstorage_box_do_authorize($res);
 cloudstorage_box_do_calcauthorization($res);
 cloudstorage_box_do_config($res, $configurationstring);
 cloudstorage_box_do_copyresource($res, $resourceid, $parentid, $newname);
 cloudstorage_box_do_createfolder($res, $foldername, $parentid);
 cloudstorage_box_do_createlink($res, $resourceid);
 cloudstorage_box_do_createmetadata($res, $resourceid, $scope, $schema);
 cloudstorage_box_do_createpreviewlink($res, $fileid);
 cloudstorage_box_do_deletemetadata($res, $resourceid, $scope, $schema);
 cloudstorage_box_do_deleteresource($res, $resourceid);
 cloudstorage_box_do_downloadfile($res, $fileid);
 cloudstorage_box_do_getaccountinfo($res);
 cloudstorage_box_do_getresourceinfo($res, $resourceid);
 cloudstorage_box_do_interrupt($res);
 cloudstorage_box_do_listmetadata($res, $resourceid, $scope, $schema);
 cloudstorage_box_do_listresources($res, $folderid);
 cloudstorage_box_do_listversions($res, $fileid);
 cloudstorage_box_do_lockfile($res, $fileid, $expiration, $allowdownloading);
 cloudstorage_box_do_moveresource($res, $resourceid, $parentid, $newname);
 cloudstorage_box_do_polluploadstatus($res);
 cloudstorage_box_do_promoteversion($res, $fileid, $versionid);
 cloudstorage_box_do_reset($res);
 cloudstorage_box_do_restoreresource($res, $resourceid, $parentid, $newname);
 cloudstorage_box_do_revokelink($res, $resourceid);
 cloudstorage_box_do_search($res, $query);
 cloudstorage_box_do_sendcustomrequest($res, $httpmethod, $requestpath, $requestbody);
 cloudstorage_box_do_unlockfile($res, $fileid);
 cloudstorage_box_do_updatemetadata($res, $resourceid, $scope, $schema);
 cloudstorage_box_do_updateresource($res, $resourceid);
 cloudstorage_box_do_uploadfile($res, $filename, $parentid);

Remarks

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

Authentication

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

The class has the following defaults:

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

Application Profile

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

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

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

Authorization Code

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

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

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerTokenURL to be set. When the Authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, OAuthServerTokenURL, and the OAuthReturnURL properties to be set. Before calling the Authorize method, the OAuthWebAuthURL property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the OAuthReturnURL property. The OAuthReturnURL property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the OAuthAuthorizationCode property. Once that is set, the Authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the OAuthRefreshToken field is set, or a refresh token is cached, then the Authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

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://app.box.com/api/oauth2/authorize"; oauth.ServerTokenURL = "https://api.box.com/oauth2/token"; oauth.WebServerPort = PORT; // http://localhost:PORT needs to be a registered redirect URL for the app box.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

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

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { box.ListResources("d:123456"); for (int i = 0; i < box.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(box.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: box.LocalFile = "../MyFile.zip"; box.DownloadFile(box.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"; box.LocalFile = downloadFile; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file box.StartByte = new FileInfo(downloadFile).Length; box.DownloadFile(box.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. box.LocalFile = "../MyFile.zip"; box.EncryptionPassword = "password"; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file box.StartByte = new FileInfo(box.Config("DownloadTempFile")).Length; box.DownloadFile(box.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

Box 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 (must be larger than 20 MB), 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. When doing a simple upload, the HashSimpleUploads setting is applicable. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files (must be larger than 20 MB). The class will automatically fragment the specified file into smaller pieces and upload each individually.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL 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 ResumeURL is populated (if the same instance of the class is used, it should already be populated, and no special action should be needed). Call PollUploadStatus to populate the correct values for StartByte and UploadFragmentSize. 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. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. box.LocalFile = "../MyFile.zip"; box.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. box.UploadFile("MyFile.zip", "");

Additional Functionality

The Box 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, MoveResource, and RestoreResource.
• Support for resource sharing using CreateLink and RevokeLink.
• Resource metadata management with CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.
• Advanced resource listing using the Search method.
• Retrieval of account and space usage details using GetAccountInfo.
• File version handling with ListVersions and PromoteVersion.
• 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.

AccountAddress Property (CloudStorage_Box Class)

The address of the account's user.

Object Oriented Interface

public function getAccountAddress();

Procedural Interface

cloudstorage_box_get($res, 1 );

Default Value

''

Remarks

The address of the account's user.

This property reflects the address of the account's user.

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

Data Type

String

AccountCreatedTime Property (CloudStorage_Box Class)

The creation timestamp of the account.

Object Oriented Interface

public function getAccountCreatedTime();

Procedural Interface

cloudstorage_box_get($res, 2 );

Default Value

''

Remarks

The creation timestamp of the account.

This property reflects the creation timestamp of the account. Timestamps are formatted according to RFC 3339.

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

Data Type

String

AccountEmail Property (CloudStorage_Box Class)

The email address of the account.

Object Oriented Interface

public function getAccountEmail();

Procedural Interface

cloudstorage_box_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

AccountEnterpriseId Property (CloudStorage_Box Class)

The Id of the enterprise the account is a member of.

Object Oriented Interface

public function getAccountEnterpriseId();

Procedural Interface

cloudstorage_box_get($res, 4 );

Default Value

''

Remarks

The Id of the enterprise the account is a member of.

This property reflects the Id of the enterprise that the account is a member of. It will be empty if the account isn't part of an enterprise.

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

Data Type

String

AccountId Property (CloudStorage_Box Class)

The Id of the account.

Object Oriented Interface

public function getAccountId();

Procedural Interface

cloudstorage_box_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

AccountModifiedTime Property (CloudStorage_Box Class)

The last modified timestamp of the account.

Object Oriented Interface

public function getAccountModifiedTime();

Procedural Interface

cloudstorage_box_get($res, 6 );

Default Value

''

Remarks

The last modified timestamp of the account.

This property reflects the last modified timestamp of the account. Timestamps are formatted according to RFC 3339.

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

Data Type

String

AccountName Property (CloudStorage_Box Class)

The name of the account's user.

Object Oriented Interface

public function getAccountName();

Procedural Interface

cloudstorage_box_get($res, 7 );

Default Value

''

Remarks

The name of the account's user.

This property reflects the name of the account's user.

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

Data Type

String

AccountPhone Property (CloudStorage_Box Class)

The phone number of the account's user.

Object Oriented Interface

public function getAccountPhone();

Procedural Interface

cloudstorage_box_get($res, 8 );

Default Value

''

Remarks

The phone number of the account's user.

This property reflects the phone number of the account's user.

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

Data Type

String

AccountRole Property (CloudStorage_Box Class)

The account's role.

Object Oriented Interface

public function getAccountRole();

Procedural Interface

cloudstorage_box_get($res, 9 );

Default Value

0

Remarks

The account's role.

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

• 0 (arUser)
• 1 (arCoadmin)
• 2 (arAdmin)

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

Data Type

Integer

AccountStatus Property (CloudStorage_Box Class)

The account's status.

Object Oriented Interface

public function getAccountStatus();

Procedural Interface

cloudstorage_box_get($res, 10 );

Default Value

0

Remarks

The account's status.

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

• 0 (asActive)
• 1 (asInactive)
• 2 (asNoDeleteOrEdit)
• 3 (asNoDeleteEditOrUpload)

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

Data Type

Integer

AccountTags Property (CloudStorage_Box Class)

The account's resource tags.

Object Oriented Interface

public function getAccountTags();

Procedural Interface

cloudstorage_box_get($res, 11 );

Default Value

''

Remarks

The account's resource tags.

This property holds a comma-separated list containing all of the tags that the account has applied to any of its resources.

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

Data Type

String

AccountTotalSpace Property (CloudStorage_Box Class)

The total amount of space allocated to the account.

Object Oriented Interface

public function getAccountTotalSpace();

Procedural Interface

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

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

Data Type

Long64

AccountUsedSpace Property (CloudStorage_Box Class)

The amount of space used by the account.

Object Oriented Interface

public function getAccountUsedSpace();

Procedural Interface

cloudstorage_box_get($res, 13 );

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

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

cloudstorage_box_get($res, 14 );
cloudstorage_box_set($res, 14, $value );

Default Value

''

Remarks

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

Bearer ACCESS_TOKEN

Assign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Data Type

String

DownloadType Property (CloudStorage_Box Class)

The download type to use for file resources.

Object Oriented Interface

public function getDownloadType();
public function setDownloadType($value);

Procedural Interface

cloudstorage_box_get($res, 15 );
cloudstorage_box_set($res, 15, $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 and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.

If Box is still in the process of generating the requested thumbnail when this method is called, the class will populate the RetryAfter configuration setting and throw an exception. Retry the request after the number of seconds indicated by RetryAfter.

This property is not available at design time.

Data Type

Integer

EncryptionAlgorithm Property (CloudStorage_Box Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_box_get($res, 16 );
cloudstorage_box_set($res, 16, $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_Box Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_box_get($res, 17 );
cloudstorage_box_set($res, 17, $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_Box Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_box_get($res, 18 );
cloudstorage_box_set($res, 18, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_Box Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudstorage_box_get($res, 19 );
cloudstorage_box_set($res, 19, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_Box Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudstorage_box_get($res, 20 );
cloudstorage_box_set($res, 20, $value );

Default Value

''

Remarks

The name or IP address of the 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_Box Class)

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_box_get($res, 21 );
cloudstorage_box_set($res, 21, $value );

Default Value

''

Remarks

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

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudstorage_box_get($res, 22 );
cloudstorage_box_set($res, 22, $value );

Default Value

0

Remarks

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

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudstorage_box_get($res, 23 );
cloudstorage_box_set($res, 23, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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_Box Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_box_get($res, 24 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_Box Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

cloudstorage_box_get($res, 25 );
cloudstorage_box_set($res, 25, $value );

Default Value

''

Remarks

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

Data Type

String

LocalHost Property (CloudStorage_Box 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_box_get($res, 26 );
cloudstorage_box_set($res, 26, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

MetadataCount Property (CloudStorage_Box Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();
public function setMetadataCount($value);

Procedural Interface

cloudstorage_box_get($res, 27 );
cloudstorage_box_set($res, 27, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataContainerSchema
• MetadataContainerScope
• MetadataModOp
• MetadataName
• MetadataResourceId
• MetadataSourceName
• MetadataValue
• MetadataValueType

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

This property is not available at design time.

Data Type

Integer

MetadataContainerSchema Property (CloudStorage_Box Class)

The schema of the metadata item's container.

Object Oriented Interface

public function getMetadataContainerSchema($metadataindex);
public function setMetadataContainerSchema($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 28 , $metadataindex);
cloudstorage_box_set($res, 28, $value , $metadataindex);

Default Value

''

Remarks

The schema of the metadata item's container.

This property specifies the metadata of the schema item's container.

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

This property is not available at design time.

Data Type

String

MetadataContainerScope Property (CloudStorage_Box Class)

The scope that the metadata item's container resides in.

Object Oriented Interface

public function getMetadataContainerScope($metadataindex);
public function setMetadataContainerScope($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 29 , $metadataindex);
cloudstorage_box_set($res, 29, $value , $metadataindex);

Default Value

''

Remarks

The scope that the metadata item's container resides in.

This property specifies the scope that the metadata item's container resides in.

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

This property is not available at design time.

Data Type

String

MetadataModOp Property (CloudStorage_Box Class)

The modification operation to perform on the metadata item.

Object Oriented Interface

public function getMetadataModOp($metadataindex);
public function setMetadataModOp($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 30 , $metadataindex);
cloudstorage_box_set($res, 30, $value , $metadataindex);

Default Value

0

Remarks

The modification operation to perform on the metadata item.

This property specifies which modification operation should be performed for the metadata item when UpdateMetadata is called. Possible values are:

Refer to UpdateMetadata for more information.

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (CloudStorage_Box Class)

The name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);
public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 31 , $metadataindex);
cloudstorage_box_set($res, 31, $value , $metadataindex);

Default Value

''

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. It cannot begin with the $ character.

This property may be used as input when CreateMetadata or UpdateMetadata is called.

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

This property is not available at design time.

Data Type

String

MetadataResourceId Property (CloudStorage_Box Class)

The Id of the resource the metadata item is associated with.

Object Oriented Interface

public function getMetadataResourceId($metadataindex);
public function setMetadataResourceId($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 32 , $metadataindex);
cloudstorage_box_set($res, 32, $value , $metadataindex);

Default Value

''

Remarks

The Id of the resource the metadata item is associated with.

This property specifies the Id of the resource the metadata item is associated with.

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

This property is not available at design time.

Data Type

String

MetadataSourceName Property (CloudStorage_Box Class)

The name of another metadata item from which to copy or move a value.

Object Oriented Interface

public function getMetadataSourceName($metadataindex);
public function setMetadataSourceName($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 33 , $metadataindex);
cloudstorage_box_set($res, 33, $value , $metadataindex);

Default Value

''

Remarks

The name of another metadata item from which to copy or move a value.

This property specifies the name of another metadata item whose value should be copied or moved to this one. It cannot begin with the $ character.

This property may be used as input when UpdateMetadata is called if the MetadataModOp property is set to one of the following:

• 3 (opCopyFrom)
• 4 (opMoveFrom)

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

This property is not available at design time.

Data Type

String

MetadataValue Property (CloudStorage_Box Class)

The value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);
public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 34 , $metadataindex);
cloudstorage_box_set($res, 34, $value , $metadataindex);

Default Value

''

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

This property may be used as input when CreateMetadata or UpdateMetadata is called if the MetadataModOp property is set to one of the following:

• 1 (opAdd)
• 2 (opReplace)
• 6 (opTest)

When this property's value is sent to the server, it is encoded according to the MetadataValueType property.

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

This property is not available at design time.

Data Type

String

MetadataValueType Property (CloudStorage_Box Class)

The type of the metadata item's value.

Object Oriented Interface

public function getMetadataValueType($metadataindex);
public function setMetadataValueType($metadataindex, $value);

Procedural Interface

cloudstorage_box_get($res, 35 , $metadataindex);
cloudstorage_box_set($res, 35, $value , $metadataindex);

Default Value

0

Remarks

The type of the metadata item's value.

This property specifies the type of the metadata item's value, and controls how the class encodes MetadataValue when submitting it to the server. Possible values, and their corresponding Box types, are:

The MetadataValue property should hold a comma-separated list of strings when this property is set to 2 (mtMultiSelect).

This property may be used as input when CreateMetadata or UpdateMetadata is called if the MetadataModOp property is set to one of the following:

• 1 (opAdd)
• 2 (opReplace)
• 6 (opTest)

Important: Box only allows string-typed metadata items in the /global/properties metadata container; the class will always ignore this property and encode metadata items as strings when creating or updating the /global/properties container.

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

This property is not available at design time.

Data Type

Integer

OAuthAccessToken Property (CloudStorage_Box Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();
public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_box_get($res, 36 );
cloudstorage_box_set($res, 36, $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_Box Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();
public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_box_get($res, 37 );
cloudstorage_box_set($res, 37, $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_Box Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();
public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_box_get($res, 38 );
cloudstorage_box_set($res, 38, $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_Box Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();
public function setOAuthClientId($value);

Procedural Interface

cloudstorage_box_get($res, 39 );
cloudstorage_box_set($res, 39, $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_Box Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();
public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_box_get($res, 40 );
cloudstorage_box_set($res, 40, $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_Box 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_box_get($res, 41 );
cloudstorage_box_set($res, 41, $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_Box 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_box_get($res, 42 );
cloudstorage_box_set($res, 42, $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_Box 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_box_get($res, 43 );
cloudstorage_box_set($res, 43, $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

OAuthRequestRefreshToken Property (CloudStorage_Box Class)

Specifies whether the class will request a refresh token during authorization.

Object Oriented Interface

public function getOAuthRequestRefreshToken();
public function setOAuthRequestRefreshToken($value);

Procedural Interface

cloudstorage_box_get($res, 44 );
cloudstorage_box_set($res, 44, $value );

Default Value

true

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.

This property is not available at design time.

Data Type

Boolean

OAuthReturnURL Property (CloudStorage_Box Class)

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

Object Oriented Interface

public function getOAuthReturnURL();
public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_box_get($res, 45 );
cloudstorage_box_set($res, 45, $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_Box Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();
public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_box_get($res, 46 );
cloudstorage_box_set($res, 46, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_Box 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_box_get($res, 47 );
cloudstorage_box_set($res, 47, $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_Box Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_box_get($res, 48 );

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

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudstorage_box_get($res, 49 );
cloudstorage_box_set($res, 49, $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_Box Class)

Determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

cloudstorage_box_get($res, 50 );
cloudstorage_box_set($res, 50, $value );

Default Value

false

Remarks

This property controls whether local files are overwritten when calling DownloadFile. It is only applicable to local files. The default value is false.

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_Box Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_box_get($res, 51 );

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_Box 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_box_get($res, 52 , $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_Box Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_box_get($res, 53 , $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_Box Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_box_get($res, 54 );
cloudstorage_box_set($res, 54, $value );

Default Value

0

Remarks

The 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 class 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_Box Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_box_get($res, 55 );
cloudstorage_box_set($res, 55, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_Box Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudstorage_box_get($res, 56 );
cloudstorage_box_set($res, 56, $value );

Default Value

''

Remarks

A password 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

ProxyPort Property (CloudStorage_Box Class)

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_box_get($res, 57 );
cloudstorage_box_set($res, 57, $value );

Default Value

80

Remarks

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_Box 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_box_get($res, 58 );
cloudstorage_box_set($res, 58, $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_Box Class)

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_box_get($res, 59 );
cloudstorage_box_set($res, 59, $value );

Default Value

0

Remarks

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

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudstorage_box_get($res, 60 );
cloudstorage_box_set($res, 60, $value );

Default Value

''

Remarks

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

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

cloudstorage_box_get($res, 61 );
cloudstorage_box_set($res, 61, $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_Box Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_box_get($res, 62 , $queryparamindex);
cloudstorage_box_set($res, 62, $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_Box Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_box_get($res, 63 , $queryparamindex);
cloudstorage_box_set($res, 63, $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_Box Class)

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

Object Oriented Interface

public function getResourceData();
public function setResourceData($value);

Procedural Interface

cloudstorage_box_get($res, 64 );
cloudstorage_box_set($res, 64, $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_Box Class)

A marker indicating what page of resources to return next.

Object Oriented Interface

public function getResourceMarker();
public function setResourceMarker($value);

Procedural Interface

cloudstorage_box_get($res, 65 );
cloudstorage_box_set($res, 65, $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_Box Class)

The number of records in the Resource arrays.

Object Oriented Interface

public function getResourceCount();
public function setResourceCount($value);

Procedural Interface

cloudstorage_box_get($res, 66 );
cloudstorage_box_set($res, 66, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceCreatedBy
• ResourceCreatedTime
• ResourceDescription
• ResourceETag
• ResourceHash
• ResourceId
• ResourceModifiedBy
• ResourceModifiedTime
• ResourceName
• ResourceOwner
• ResourceParentId
• ResourceSharedLink
• ResourceSharedLinkAccess
• ResourceSharedLinkProtected
• ResourceSize
• ResourceSyncState
• ResourceTags
• ResourceTrashed
• ResourceTrashedTime
• ResourceType
• ResourceVersionId

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

This property is not available at design time.

Data Type

Integer

ResourceCreatedBy Property (CloudStorage_Box Class)

The email address of the user who created the resource.

Object Oriented Interface

public function getResourceCreatedBy($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 67 , $resourceindex);

Default Value

''

Remarks

The email address of the user who created the resource.

This property reflects the email address of the user who created 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

ResourceCreatedTime Property (CloudStorage_Box Class)

The creation timestamp of the resource.

Object Oriented Interface

public function getResourceCreatedTime($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 68 , $resourceindex);

Default Value

''

Remarks

The creation timestamp of the resource.

This property reflects the creation timestamp of the resource. Timestamps are formatted according to RFC 3339.

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

ResourceDescription Property (CloudStorage_Box Class)

A description of the resource.

Object Oriented Interface

public function getResourceDescription($resourceindex);
public function setResourceDescription($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 69 , $resourceindex);
cloudstorage_box_set($res, 69, $value , $resourceindex);

Default Value

''

Remarks

A description of the resource.

This property specifies a description 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 not available at design time.

Data Type

String

ResourceETag Property (CloudStorage_Box Class)

The ETag of the resource.

Object Oriented Interface

public function getResourceETag($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 70 , $resourceindex);

Default Value

''

Remarks

The ETag of the resource.

This property reflects the ETag 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

ResourceHash Property (CloudStorage_Box Class)

A SHA1 hash of the file resource's content.

Object Oriented Interface

public function getResourceHash($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 71 , $resourceindex);

Default Value

''

Remarks

A SHA1 hash of the file resource's content.

This property holds a SHA1 hash of the file resource's content. 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

ResourceId Property (CloudStorage_Box Class)

The Id of the resource.

Object Oriented Interface

public function getResourceId($resourceindex);
public function setResourceId($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 72 , $resourceindex);
cloudstorage_box_set($res, 72, $value , $resourceindex);

Default Value

''

Remarks

The Id of the resource.

This property specifies 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 not available at design time.

Data Type

String

ResourceModifiedBy Property (CloudStorage_Box Class)

The email address of the user who last modified the resource.

Object Oriented Interface

public function getResourceModifiedBy($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 73 , $resourceindex);

Default Value

''

Remarks

The email address of the user who last modified the resource.

This property reflects the email address of the user who last modified 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_Box Class)

The last modified timestamp of the resource.

Object Oriented Interface

public function getResourceModifiedTime($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 74 , $resourceindex);

Default Value

''

Remarks

The last modified timestamp of the resource.

This property reflects the last modified timestamp of the resource. Timestamps are formatted according to RFC 3339.

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

The name of the resource.

Object Oriented Interface

public function getResourceName($resourceindex);
public function setResourceName($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 75 , $resourceindex);
cloudstorage_box_set($res, 75, $value , $resourceindex);

Default Value

''

Remarks

The name of the resource.

This property specifies 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 not available at design time.

Data Type

String

ResourceOwner Property (CloudStorage_Box Class)

The email address of the user who owns the resource.

Object Oriented Interface

public function getResourceOwner($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 76 , $resourceindex);

Default Value

''

Remarks

The email address of the user who owns the resource.

This property reflects the email address of the user who owns 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

ResourceParentId Property (CloudStorage_Box Class)

The Id of the resource's parent.

Object Oriented Interface

public function getResourceParentId($resourceindex);
public function setResourceParentId($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 77 , $resourceindex);
cloudstorage_box_set($res, 77, $value , $resourceindex);

Default Value

''

Remarks

The Id of the resource's parent.

This property specifies the Id of the resource's parent.

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 not available at design time.

Data Type

String

ResourceSharedLink Property (CloudStorage_Box Class)

The URL of the resource's shared link.

Object Oriented Interface

public function getResourceSharedLink($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 78 , $resourceindex);

Default Value

''

Remarks

The URL of the resource's shared link.

This property holds the URL of the resource's shared link, or empty string if the resource doesn't currently have an active shared link.

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

ResourceSharedLinkAccess Property (CloudStorage_Box Class)

Access level afforded by the resource's shared link.

Object Oriented Interface

public function getResourceSharedLinkAccess($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 79 , $resourceindex);

Default Value

0

Remarks

Access level afforded by the resource's shared link.

This property reflects the access level that the resource's ResourceSharedLink provides. 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

ResourceSharedLinkProtected Property (CloudStorage_Box Class)

Whether the resource's shared link is password-protected.

Object Oriented Interface

public function getResourceSharedLinkProtected($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 80 , $resourceindex);

Default Value

false

Remarks

Whether the resource's shared link is password-protected.

This property indicates whether the resource's shared link is password-protected.

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

ResourceSize Property (CloudStorage_Box Class)

The size of the resource.

Object Oriented Interface

public function getResourceSize($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 81 , $resourceindex);

Default Value

0

Remarks

The size of the resource.

This property reflects the size of the resource, in bytes. For folder resources, this is the total size of everything within the 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

Long64

ResourceSyncState Property (CloudStorage_Box Class)

The sync state of the folder resource.

Object Oriented Interface

public function getResourceSyncState($resourceindex);
public function setResourceSyncState($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 82 , $resourceindex);
cloudstorage_box_set($res, 82, $value , $resourceindex);

Default Value

0

Remarks

The sync state of the folder resource.

This property specifies the sync state of the folder resource. Not applicable for file resources. 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 not available at design time.

Data Type

Integer

ResourceTags Property (CloudStorage_Box Class)

Tags applied to the resource.

Object Oriented Interface

public function getResourceTags($resourceindex);
public function setResourceTags($resourceindex, $value);

Procedural Interface

cloudstorage_box_get($res, 83 , $resourceindex);
cloudstorage_box_set($res, 83, $value , $resourceindex);

Default Value

''

Remarks

Tags applied to the resource.

This property specifies a comma-separated list of tags applied to 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 not available at design time.

Data Type

String

ResourceTrashed Property (CloudStorage_Box Class)

Whether the resource is in the trash.

Object Oriented Interface

public function getResourceTrashed($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 84 , $resourceindex);

Default Value

false

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

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

ResourceTrashedTime Property (CloudStorage_Box Class)

The trashed timestamp of the resource.

Object Oriented Interface

public function getResourceTrashedTime($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 85 , $resourceindex);

Default Value

''

Remarks

The trashed timestamp of the resource.

This property reflects the trashed timestamp of the resource. Timestamps are formatted according to RFC 3339.

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

ResourceType Property (CloudStorage_Box Class)

The resource's type.

Object Oriented Interface

public function getResourceType($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 86 , $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

ResourceVersionId Property (CloudStorage_Box Class)

The version Id of the file resource.

Object Oriented Interface

public function getResourceVersionId($resourceindex);

Procedural Interface

cloudstorage_box_get($res, 87 , $resourceindex);

Default Value

''

Remarks

The version Id of the file resource.

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

Note that Box only tracks file versions for paid accounts.

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

ResumeURL Property (CloudStorage_Box Class)

The resumable upload URL.

Object Oriented Interface

public function getResumeURL();
public function setResumeURL($value);

Procedural Interface

cloudstorage_box_get($res, 88 );
cloudstorage_box_set($res, 88, $value );

Default Value

''

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when UseResumableUpload is set to true and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

This property is not available at design time.

Data Type

String

SearchMarker Property (CloudStorage_Box 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_box_get($res, 89 );
cloudstorage_box_set($res, 89, $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

SSLAcceptServerCertEffectiveDate Property (CloudStorage_Box Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudstorage_box_get($res, 90 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudStorage_Box Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudstorage_box_get($res, 91 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudStorage_Box Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_box_get($res, 92 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudStorage_Box Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudstorage_box_get($res, 93 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudStorage_Box Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 94 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudStorage_Box Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 95 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudStorage_Box Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudstorage_box_get($res, 96 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudStorage_Box Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudstorage_box_get($res, 97 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudStorage_Box Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_box_get($res, 98 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudStorage_Box Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_box_get($res, 99 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudStorage_Box Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudstorage_box_get($res, 100 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudStorage_Box Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 101 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudStorage_Box Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudstorage_box_get($res, 102 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudStorage_Box Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudstorage_box_get($res, 103 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudStorage_Box Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 104 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudStorage_Box Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudstorage_box_get($res, 105 );
cloudstorage_box_set($res, 105, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudStorage_Box 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudstorage_box_get($res, 106 );
cloudstorage_box_set($res, 106, $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

SSLAcceptServerCertStoreType Property (CloudStorage_Box Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudstorage_box_get($res, 107 );
cloudstorage_box_set($res, 107, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (CloudStorage_Box Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudstorage_box_get($res, 108 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudStorage_Box Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudstorage_box_get($res, 109 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudStorage_Box Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 110 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudStorage_Box Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 111 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudStorage_Box Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudstorage_box_get($res, 112 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudStorage_Box Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudstorage_box_get($res, 113 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudStorage_Box Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudstorage_box_get($res, 114 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudStorage_Box Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudstorage_box_get($res, 115 );
cloudstorage_box_set($res, 115, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (CloudStorage_Box Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_box_get($res, 116 );
cloudstorage_box_set($res, 116, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (CloudStorage_Box Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudstorage_box_get($res, 117 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudStorage_Box Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudstorage_box_get($res, 118 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudStorage_Box Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudstorage_box_get($res, 119 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudStorage_Box Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudstorage_box_get($res, 120 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudStorage_Box Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 121 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudStorage_Box Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 122 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudStorage_Box Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudstorage_box_get($res, 123 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudStorage_Box Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudstorage_box_get($res, 124 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudStorage_Box Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_box_get($res, 125 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudStorage_Box Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudstorage_box_get($res, 126 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudStorage_Box Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudstorage_box_get($res, 127 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudStorage_Box Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 128 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudStorage_Box Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudstorage_box_get($res, 129 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudStorage_Box Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudstorage_box_get($res, 130 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudStorage_Box Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 131 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudStorage_Box Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudstorage_box_get($res, 132 );
cloudstorage_box_set($res, 132, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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_Box 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_box_get($res, 133 );
cloudstorage_box_set($res, 133, $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_Box Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_box_get($res, 134 );
cloudstorage_box_set($res, 134, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (CloudStorage_Box Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudstorage_box_get($res, 135 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudStorage_Box Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudstorage_box_get($res, 136 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudStorage_Box Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 137 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudStorage_Box Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 138 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudStorage_Box Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudstorage_box_get($res, 139 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudStorage_Box Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudstorage_box_get($res, 140 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudStorage_Box Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudstorage_box_get($res, 141 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudStorage_Box Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_box_get($res, 142 );
cloudstorage_box_set($res, 142, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (CloudStorage_Box Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_box_get($res, 143 );
cloudstorage_box_set($res, 143, $value );

Default Value

''

Remarks

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

SSLProvider Property (CloudStorage_Box Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudstorage_box_get($res, 144 );
cloudstorage_box_set($res, 144, $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 as follows:

Additional Notes

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

SSLServerCertEffectiveDate Property (CloudStorage_Box Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudstorage_box_get($res, 145 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudStorage_Box Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudstorage_box_get($res, 146 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudStorage_Box Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudstorage_box_get($res, 147 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudStorage_Box Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudstorage_box_get($res, 148 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudStorage_Box Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 149 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudStorage_Box Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 150 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudStorage_Box Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudstorage_box_get($res, 151 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudStorage_Box Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudstorage_box_get($res, 152 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudStorage_Box Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudstorage_box_get($res, 153 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudStorage_Box Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudstorage_box_get($res, 154 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudStorage_Box Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudstorage_box_get($res, 155 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudStorage_Box Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 156 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudStorage_Box Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudstorage_box_get($res, 157 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudStorage_Box Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudstorage_box_get($res, 158 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudStorage_Box Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudstorage_box_get($res, 159 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudStorage_Box Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudstorage_box_get($res, 160 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudStorage_Box 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 getSSLServerCertStorePassword();

Procedural Interface

cloudstorage_box_get($res, 161 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudStorage_Box Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudstorage_box_get($res, 162 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudStorage_Box Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudstorage_box_get($res, 163 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudStorage_Box Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudstorage_box_get($res, 164 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudStorage_Box Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudstorage_box_get($res, 165 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudStorage_Box Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudstorage_box_get($res, 166 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudStorage_Box Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudstorage_box_get($res, 167 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudStorage_Box Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudstorage_box_get($res, 168 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudStorage_Box Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudstorage_box_get($res, 169 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudStorage_Box Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudstorage_box_get($res, 170 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudStorage_Box Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_box_get($res, 171 );

Default Value

''

Remarks

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_Box 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_box_get($res, 172 );
cloudstorage_box_set($res, 172, $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_Box Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudstorage_box_get($res, 173 );
cloudstorage_box_set($res, 173, $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.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (CloudStorage_Box Class)

Whether to use resumable uploads.

Object Oriented Interface

public function getUseResumableUpload();
public function setUseResumableUpload($value);

Procedural Interface

cloudstorage_box_get($res, 174 );
cloudstorage_box_set($res, 174, $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

VersionMarker Property (CloudStorage_Box Class)

A marker indicating what page of file versions to return next.

Object Oriented Interface

public function getVersionMarker();
public function setVersionMarker($value);

Procedural Interface

cloudstorage_box_get($res, 175 );
cloudstorage_box_set($res, 175, $value );

Default Value

''

Remarks

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

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AbortUpload Method (CloudStorage_Box Class)

Aborts the current resumable upload session.

Object Oriented Interface

public function doAbortUpload();

Procedural Interface

cloudstorage_box_do_abortupload($res);

Remarks

This method aborts the current resumable upload session specified by ResumeURL. It may be called if the current resumable upload has been interrupted and will not be resumed.

AddQueryParam Method (CloudStorage_Box Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

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

Remarks

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

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

Authorize Method (CloudStorage_Box Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

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

For more information, see the introduction section.

CalcAuthorization Method (CloudStorage_Box Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_box_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_Box Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_box_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_Box Class)

Copies a resource.

Object Oriented Interface

public function doCopyResource($resourceid, $parentid, $newname);

Procedural Interface

cloudstorage_box_do_copyresource($res, $resourceid, $parentid, $newname);

Remarks

This method copies the resource specified by ResourceId to the folder specified by ParentId. The Id of the newly-copied resource is returned.

NewName specifies the name of the copied resource; if empty, the resource's original name is used. ParentId can also be empty, in which case the resource is copied to the root folder.

NewName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

Note that copy operations for folders with greater than 500 children (counted recursively) are performed asynchronously; the server will return the Id of the newly-copied folder resource immediately while continuing to perform the copy operation over time. There is no way to monitor an asynchronous copy operation.

CreateFolder Method (CloudStorage_Box Class)

Creates a new folder resource.

Object Oriented Interface

public function doCreateFolder($foldername, $parentid);

Procedural Interface

cloudstorage_box_do_createfolder($res, $foldername, $parentid);

Remarks

This method creates a new folder resource named FolderName in the folder specified by ParentId. The Id of the newly-created folder resource is returned.

FolderName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

ParentId can be empty, in which case the folder is created in the root folder.

CreateLink Method (CloudStorage_Box Class)

Creates a shared link.

Object Oriented Interface

public function doCreateLink($resourceid);

Procedural Interface

cloudstorage_box_do_createlink($res, $resourceid);

Remarks

This method creates a shared link for the resource specified by ResourceId. The URL of the shared link is returned.

Only one shared link may be active at a time for each resource; calling this method for a resource that already has an active shared link will update the shared link's settings without changing its URL.

The following configuration settings may be used to configure the shared link:

• CreateLinkAccess
• CreateLinkAllowDownloads
• CreateLinkExpiration
• CreateLinkPassword

// Create a password-protected shared link for the given file. box.Config("CreateLinkPassword=password"); string sharingUrl = box.CreateLink("f:09876");

CreateMetadata Method (CloudStorage_Box Class)

Creates a new metadata container on a resource.

Object Oriented Interface

public function doCreateMetadata($resourceid, $scope, $schema);

Procedural Interface

cloudstorage_box_do_createmetadata($res, $resourceid, $scope, $schema);

Remarks

This method creates a new metadata container on the resource specified by ResourceId. The metadata container is created using the specified Scope and Schema.

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

When this method is called, any Metadata collection items that satisfy all of the following constraints will be added to the new metadata container immediately (assuming the server returns no errors):

• Their MetadataModOp properties must be set to 1 (opAdd).
• Their MetadataResourceId properties must be empty, or must match the value provided for ResourceId.
• Their MetadataContainerScope properties must be empty, or must match the value provided for Scope.
• Their MetadataContainerSchema properties must be empty, or must match the value provided for Schema.

All applicable metadata items will have their MetadataModOp property reset to 0 (opNone) if the request succeeds.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

CreatePreviewLink Method (CloudStorage_Box Class)

Creates a preview link.

Object Oriented Interface

public function doCreatePreviewLink($fileid);

Procedural Interface

cloudstorage_box_do_createpreviewlink($res, $fileid);

Remarks

This method creates a preview link for the file resource specified by FileId. The URL of the preview link is returned. Preview links are suitable for embedding in iframes.

Note that preview links expire after 60 seconds, and the preview session expires after 60 minutes. Not all files support previewing.

DeleteMetadata Method (CloudStorage_Box Class)

Deletes a metadata container from a resource.

Object Oriented Interface

public function doDeleteMetadata($resourceid, $scope, $schema);

Procedural Interface

cloudstorage_box_do_deletemetadata($res, $resourceid, $scope, $schema);

Remarks

This method deletes the metadata container specified by Scope and Schema from the resource specified by ResourceId. All metadata items held by the specified container are also deleted (individual metadata items can be deleted from a container using the UpdateMetadata method; refer to its documentation for more information).

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

DeleteResource Method (CloudStorage_Box Class)

Trashes or permanently deletes a resource.

Object Oriented Interface

public function doDeleteResource($resourceid);

Procedural Interface

cloudstorage_box_do_deleteresource($res, $resourceid);

Remarks

This method trashes the resource specified by ResourceId. If the resource is already in the trash, it is permanently deleted instead.

To list trashed resources, call ListResources and pass trash for the FolderId method parameter.

DownloadFile Method (CloudStorage_Box Class)

Downloads a file resource.

Object Oriented Interface

public function doDownloadFile($fileid);

Procedural Interface

cloudstorage_box_do_downloadfile($res, $fileid);

Remarks

This method downloads the file resource specified by FileId.

The DownloadType property can be used to control whether this method downloads the file contents (default) or a file thumbnail. Refer to DownloadType 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: box.LocalFile = "../MyFile.zip"; box.DownloadFile(box.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"; box.LocalFile = downloadFile; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file box.StartByte = new FileInfo(downloadFile).Length; box.DownloadFile(box.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. box.LocalFile = "../MyFile.zip"; box.EncryptionPassword = "password"; box.DownloadFile(box.Resources[0].Id); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file box.StartByte = new FileInfo(box.Config("DownloadTempFile")).Length; box.DownloadFile(box.Resources[0].Id);

GetAccountInfo Method (CloudStorage_Box Class)

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

Object Oriented Interface

public function doGetAccountInfo();

Procedural Interface

cloudstorage_box_do_getaccountinfo($res);

Remarks

This method gets information about the current user's account and space usage, populating the Account object property's properties.

GetResourceInfo Method (CloudStorage_Box Class)

Gets information about a specific resource.

Object Oriented Interface

public function doGetResourceInfo($resourceid);

Procedural Interface

cloudstorage_box_do_getresourceinfo($res, $resourceid);

Remarks

This method gets information about the resource specified by ResourceId.

ResourceId can be empty string to get information about the root folder.

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

Interrupt Method (CloudStorage_Box Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_box_do_interrupt($res);

Remarks

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

ListMetadata Method (CloudStorage_Box Class)

Lists the metadata items for a resource.

Object Oriented Interface

public function doListMetadata($resourceid, $scope, $schema);

Procedural Interface

cloudstorage_box_do_listmetadata($res, $resourceid, $scope, $schema);

Remarks

This method lists the metadata items for the resource specified by ResourceId. If Scope and Schema are both empty, metadata items from all metadata containers associated with the resource are returned. Otherwise, only the items in the container specified by Scope and Schema are returned.

When non-empty, Scope and Schema must either be global and properties (respectively); or enterprise_<EnterpriseId> and the name of an existing metadata container within that scope on the specified resource.

Calling this method will fire the MetadataList event once for each metadata item, and will populate the Metadata properties (clearing any previously-held items in the process).

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

ListResources Method (CloudStorage_Box Class)

Lists resources.

Object Oriented Interface

public function doListResources($folderid);

Procedural Interface

cloudstorage_box_do_listresources($res, $folderid);

Remarks

This method lists resources within the folder specified by FolderId.

FolderId can be empty string to list resources in the root folder, or trash to list trashed resources.

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

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

The MaxResults configuration setting can be used to control the maximum number of results to return at once. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { box.ListResources("d:123456"); for (int i = 0; i < box.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(box.ResourceMarker));

ListVersions Method (CloudStorage_Box Class)

Lists previous versions of a file resource.

Object Oriented Interface

public function doListVersions($fileid);

Procedural Interface

cloudstorage_box_do_listversions($res, $fileid);

Remarks

This method lists previous versions of the file resource specified by FileId. The current version is not included in the results.

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

If there are still more file versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned.

Note that Box only returns certain resource details when listing file versions; this is a limitation of the Box API that cannot be changed. Specifically, the following properties are returned:

• ResourceCreatedTime
• ResourceHash
• ResourceId (populated by the class for convenience)
• ResourceModifiedBy
• ResourceModifiedTime
• ResourceName
• ResourceSize
• ResourceType (always 0 (brtFile))
• ResourceVersionId

The MaxResults configuration setting can be used to control the maximum number of results to return at once.

Note that Box only tracks file versions for paid accounts. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name + ", Version: " + e.VersionId); }; do { box.ListVersions("f:09876"); for (int i = 0; i < box.Resources.Count; i++) { // Process resource versions here. } } while (!string.IsNullOrEmpty(box.VersionMarker));

LockFile Method (CloudStorage_Box Class)

Locks a file resource.

Object Oriented Interface

public function doLockFile($fileid, $expiration, $allowdownloading);

Procedural Interface

cloudstorage_box_do_lockfile($res, $fileid, $expiration, $allowdownloading);

Remarks

This method locks the file resource specified by FileId to prevent others from modifying it.

Expiration may be set to an appropriately-formatted timestamp to specify an expiration time for the file lock. If Expiration is empty, the file lock will never expire. Timestamps are formatted according to RFC 3339.

AllowDownloading specifies whether others should still be allowed to download the file while it's locked.

MoveResource Method (CloudStorage_Box Class)

Moves a resource.

Object Oriented Interface

public function doMoveResource($resourceid, $parentid, $newname);

Procedural Interface

cloudstorage_box_do_moveresource($res, $resourceid, $parentid, $newname);

Remarks

This method moves the resource specified by ResourceId to the folder specified by ParentId.

NewName specifies the new name of the resource; if empty, the resource's original name is used. ParentId can also be empty, in which case the resource is moved to the root folder.

NewName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

When moving a folder that contains many items, keep in mind that Box always performs move operations synchronously (whereas copy operations are performed asynchronously for folders that contain more than 500 items). This method will block until the move operation completes, unless the class times out the request based on the current value of Timeout.

PollUploadStatus Method (CloudStorage_Box Class)

Gets the status of the current resumable upload session.

Object Oriented Interface

public function doPollUploadStatus();

Procedural Interface

cloudstorage_box_do_polluploadstatus($res);

Remarks

This method retrieves the status of the resumable upload session specified by ResumeURL.

After calling this method, the StartByte property and UploadExpDate and UploadFragmentSize configuration settings will be populated.

PromoteVersion Method (CloudStorage_Box Class)

Promotes a previous file resource version to be the current version.

Object Oriented Interface

public function doPromoteVersion($fileid, $versionid);

Procedural Interface

cloudstorage_box_do_promoteversion($res, $fileid, $versionid);

Remarks

This method promotes a previous version of the file resource specified by FileId to be the current version.

VersionId specifies the version that should be promoted. Box will make a copy of it to use as the new version.

Note that Box only tracks file versions for paid accounts.

Reset Method (CloudStorage_Box Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_box_do_reset($res);

Remarks

This method resets the class to its initial state.

RestoreResource Method (CloudStorage_Box Class)

Restores a resource from the trash.

Object Oriented Interface

public function doRestoreResource($resourceid, $parentid, $newname);

Procedural Interface

cloudstorage_box_do_restoreresource($res, $resourceid, $parentid, $newname);

Remarks

This method restores the resource specified by ResourceId from the trash.

Box will always ignore ParentId and/or NewName in favor of restoring a trashed resource to its original location with its original name if possible. The ParentId and NewName parameters are only considered if one or both of the following are true:

• The original parent folder resource no longer exists (in which case ParentId will be used instead, if not empty).
• The original resource name is already in use in the original (or new) parent folder (in which case NewName will be used instead, if not empty).

RevokeLink Method (CloudStorage_Box Class)

Revokes a shared link.

Object Oriented Interface

public function doRevokeLink($resourceid);

Procedural Interface

cloudstorage_box_do_revokelink($res, $resourceid);

Remarks

This method revokes the shared link for the resource specified by ResourceId. If the specified resource doesn't have a shared link active, this method does nothing.

Search Method (CloudStorage_Box Class)

Searches for resources that match the specified query.

Object Oriented Interface

public function doSearch($query);

Procedural Interface

cloudstorage_box_do_search($res, $query);

Remarks

This method searches for resources that match the given Query, which the server will match against names, descriptions, file contents, etc.

Advanced searches can be performed by adding additional query parameters using the AddQueryParam method. Here are examples of some of the more common query parameters:

Box supports many other query parameters not shown here. Refer to the Box API documentation for an exhaustive list of possible query parameters.

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

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

The MaxSearchResults configuration setting can be used to control the maximum number of results to return at once.

SendCustomRequest Method (CloudStorage_Box Class)

Sends a custom request to the Box API.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Box 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 Box API endpoint, https://api.box.com/2.0.
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

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

UnlockFile Method (CloudStorage_Box Class)

Unlocks a locked file resource.

Object Oriented Interface

public function doUnlockFile($fileid);

Procedural Interface

cloudstorage_box_do_unlockfile($res, $fileid);

Remarks

This method unlocks a file resource, specified by FileId, previously locked by the current account.

UpdateMetadata Method (CloudStorage_Box Class)

Updates the metadata items for an existing metadata container.

Object Oriented Interface

public function doUpdateMetadata($resourceid, $scope, $schema);

Procedural Interface

cloudstorage_box_do_updatemetadata($res, $resourceid, $scope, $schema);

Remarks

This method updates the metadata items for an existing metadata container, specified by Scope and Schema, that is associated with the resource specified by ResourceId.

Scope must be global or an enterprise-specific scope of the form enterprise_<EnterpriseId>. If Scope is empty, global is used.

If Scope is global, then Schema must be properties; otherwise, it must be the name of an existing metadata container schema owned by the enterprise identified in Scope. If Schema is empty, properties is used.

Each item in the Metadata properties has a MetadataModOp property which can be set to one of the following values:

When this method is called, the class will iterate through the Metadata properties and build up a modification request that includes the specified operation for each applicable metadata item. For a metadata item to be included in the request, all of the following must be true:

• Its MetadataModOp property must not be set to 0 (opNone).
• Its MetadataResourceId property must be empty, or must match the value provided for ResourceId.
• Its MetadataContainerScope property must be empty, or must match the value provided for Scope.
• Its MetadataContainerSchema property must be empty, or must match the value provided for Schema.

A couple of things to keep in mind regarding metadata item modification operations:

• Box applies each modification operation in the request sequentially, so the order in which they are transmitted is significant (though it may not impact all use-cases).
  • By default, the class transmits the applicable modification operations based on the order of the Metadata items.
  • To specify an explicit order, the MetadataUpdateOrder configuration setting can be set to a comma-separated list of Metadata item indices.
• Box guarantees overall atomicity for the request; if the modification operation for any one item fails, then the whole request fails, and no changes are made.
• If the request completes successfully, the class will reset all affected metadata items' MetadataModOp properties back to 0 (opNone).

Usage

ListMetadata must be called before using this method in order to populate the Metadata properties with a resource's existing metadata items. (When creating new metadata items, calling ListMetadata first is optional, but still recommended to ensure that the class reflects the latest information.)

To create new metadata items, add new items to the Metadata properties by incrementing the MetadataCount property as necessary.

For each metadata item being created or updated, set its properties to the desired values. The MetadataModOp property should be set to a value other than 0 (opNone).

Once the metadata items have been set up as desired, call this method.

Metadata Notes

Box's Metadata architecture consists of two entities: metadata items, and metadata containers (which Box calls "metadata templates").

A metadata item is just a name-value pair held by a metadata container. Its name may be up to 256 characters long, cannot begin with the $ character, and must be unique within the container.

A metadata container holds metadata items, and is associated with a single resource. All metadata containers must be created using a metadata container schema, which describes the possible metadata items the container may hold. Containers are uniquely identified (per-resource) by a schema path like /Scope/Schema (ergo, a resource cannot have multiple containers of the same schema).

Box provides a general-use schema, /global/properties, that functions as an unrestricted key-value store that will accept any metadata item. Enterprises can also create custom schemas, /enterprise_<EnterpriseId>/Schema, that only allow predefined metadata items (with specific data types) to be added.

See the following methods for more information: CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.

Note that metadata is only usable on resources owned by paid Box accounts. string resId = "f:09876"; // Create an instance of the default metadata container ("/global/properties") with a couple of metadata // items in it, and associate it with the specified resource. (Note that we're assuming that the given // resource doesn't already have an instance of the default metadata container associated with it.) box.Metadata.Add(new BoxMetadata() { Name = "num1", Value = "123", ModOp = BoxMetadataModOps.opAdd }); box.Metadata.Add(new BoxMetadata() { Name = "text1", Value = "abc", ModOp = BoxMetadataModOps.opAdd }); // All of the class's metadata-related methods all empty string to be passed to their Scope and Schema // parameters, in which case "global" and "properties" will be used, respectively. (The exception is the // ListMetadata() method, which interprets empty Scope and Schema values in a different way; refer to the // ListMetadata() documentation for more information.) box.CreateMetadata(resId, "", ""); // Some time later, imagine you wish to update the metadata items held by the default container on that // resource. Always call ListMetadata() first so that class has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the class has the latest metadata items loaded for the default container on the given // resource, we can modify what we wish to, setting the ModOp fields appropriately. box.Metadata[0].Value = "456"; // Update the value of the "num1" item. box.Metadata[0].ModOp = BoxMetadataModOps.opReplace; box.Metadata[1].ModOp = BoxMetadataModOps.opRemove; // Remove the "text1" item. // Add a new "text2" item. box.Metadata.Add(new BoxMetadata() { Name = "text2", Value = "def", ModOp = BoxMetadataModOps.opAdd }); // Now commit the updates. Our example performs very simple updates, but you can build a very complex // update scenario using some of the other ModOp values. Refer to the UpdateMetadata() documentation // for more information. box.UpdateMetadata(resId, "", ""); // Finally, this will remove the entire default metadata container from the given resource. box.DeleteMetadata(resId, "", "");

UpdateResource Method (CloudStorage_Box Class)

Updates a resource.

Object Oriented Interface

public function doUpdateResource($resourceid);

Procedural Interface

cloudstorage_box_do_updateresource($res, $resourceid);

Remarks

This method updates the information for the resource specified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

There must be a BoxResource properties whose ResourceId property matches the given ResourceId parameter before this method is called.

1. If necessary, call GetResourceInfo or ListResources to ensure an item with the resource's latest information is present in the Resources properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • ResourceDescription
   • ResourceName (the same restrictions as described in UploadFile apply)
   • ResourceParentId (only updated if not empty; d:0 can be used to move the resource to the root folder)
   • ResourceSyncState (only applicable for folder resources; only updated if set to 1 (ssSynced) or 2 (ssNotSynced))
   • ResourceTags
3. For file resources, you may set LocalFile or ResourceData if you wish to update the file data on the server. (Refer to UploadFile for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
   • Like with UploadFile, the ClientModifiedTime configuration setting may be set when updating file data.
4. Finally, call this method to update the resource.

// Load the latest information about the resource into the Resources collection. string resId = "f:09876"; box.GetResourceInfo(resId); // We'll update the file resource's name, description, and content. box.ResourceData = "new file content"; box.Resources[0].Name = "CoolStuff2.txt"; box.Resources[0].Description = "This is a text file with cool stuff in it"; box.UpdateResource(resId);

UploadFile Method (CloudStorage_Box Class)

Uploads a new file resource.

Object Oriented Interface

public function doUploadFile($filename, $parentid);

Procedural Interface

cloudstorage_box_do_uploadfile($res, $filename, $parentid);

Remarks

This method uploads a new file resource named FileName to the folder specified by ParentId. The Id of the newly-created file resource is returned.

FileName must be no longer than 255 characters; may not contain /, \, non-printable ASCII characters, or trailing whitespace; and cannot be one of the special names . or ...

ParentId can be empty, in which case the file is uploaded to the root folder.

The ClientCreatedTime and ClientModifiedTime configuration settings may be set before calling this method to submit those timestamps along with the file data.

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

Box 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 (must be larger than 20 MB), 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. When doing a simple upload, the HashSimpleUploads setting is applicable. box.LocalFile = "../MyFile.zip"; box.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files (must be larger than 20 MB). The class will automatically fragment the specified file into smaller pieces and upload each individually.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the class. ResumeURL is populated with a URL 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 ResumeURL is populated (if the same instance of the class is used, it should already be populated, and no special action should be needed). Call PollUploadStatus to populate the correct values for StartByte and UploadFragmentSize. 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. PollUploadStatus may be used to check the status of a resumable upload, including when it will expire (which is stored in the UploadExpDate configuration setting). An interrupted upload can be aborted explicitly using the AbortUpload method. box.LocalFile = "../MyFile.zip"; box.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. box.UploadFile("MyFile.zip", "");

EndTransfer Event (CloudStorage_Box Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fires after each fragment of a resumable upload is completed.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

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

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

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

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

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

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

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

Message is the log entry.

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

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

MetadataList Event (CloudStorage_Box Class)

Fires once for each metadata item when listing a resource metadata.

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

cloudstorage_box_register_callback($res, 6, array($this, 'fireMetadataList'));

Parameter List

 'name'
 'value'
 'valuetype'
 'containerscope'
 'containerschema'
 'resourceid'

Remarks

This event fires once for each metadata item returned when ListMetadata is called.

Name is the name of the metadata item.

Value is the value of the metadata item.

ValueType is the value of the metadata item. Possible values, and their corresponding Box types, are:

ContainerScope is the scope that the metadata item's container resides in.

ContainerSchema is the schema of the metadata item's container.

ResourceId is the Id of the resource that the metadata is associated with.

Note that metadata is only usable on resources owned by paid Box accounts.

Progress Event (CloudStorage_Box Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_box_register_callback($res, 7, 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_Box Class)

Fires once for each resource returned when listing resources or versions.

Object Oriented Interface

public function fireResourceList($param);

Procedural Interface

cloudstorage_box_register_callback($res, 8, array($this, 'fireResourceList'));

Parameter List

 'id'
 'name'
 'description'
 'resourcetype'
 'createdtime'
 'modifiedtime'
 'size'
 'versionid'
 'etag'
 'hash'
 'trashed'
 'sharedlink'

Remarks

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

Id is the Id of the resource.

Name is the name of the resource.

Description is a description of the resource.

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

CreatedTime and ModifiedTime reflect the resource's creation and last modified timestamps. Timestamps are formatted according to RFC 3339.

Size is the size of the resource (for folders, their contents' total size), in bytes.

VersionId is the version Id of the file resource. Not applicable for file resources. (Note that Box only tracks file versions for paid accounts.)

ETag is the ETag of the resource.

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

Trashed indicates whether the resource is in the trash.

SharedLink is the shared link URL for the resource. May be empty if the resource doesn't have a shared link active.

SSLServerAuthentication Event (CloudStorage_Box Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_box_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_Box Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_box_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_Box Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_box_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 (Box Class)

The class accepts one or more of the following configuration settings. Configuration 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.

Box Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (Box Class)

Common Errors

Box 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