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* properties to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Authorization Server URL "https://app.box.com/api/oauth2/authorize"
Token Server URL "https://api.box.com/oauth2/token"

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

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resource* properties. // ResourceList event handler. 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:

Property List


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

AccountAddressThe address of the account's user.
AccountCreatedTimeThe creation timestamp of the account.
AccountEmailThe email address of the account.
AccountEnterpriseIdThe Id of the enterprise the account is a member of.
AccountIdThe Id of the account.
AccountModifiedTimeThe last modified timestamp of the account.
AccountNameThe name of the account's user.
AccountPhoneThe phone number of the account's user.
AccountRoleThe account's role.
AccountStatusThe account's status.
AccountTagsThe account's resource tags.
AccountTotalSpaceThe total amount of space allocated to the account.
AccountUsedSpaceThe amount of space used by the account.
AuthorizationOAuth 2.0 Authorization Token.
DownloadTypeThe download type to use for file resources.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MetadataCountThe number of records in the Metadata arrays.
MetadataContainerSchemaThe schema of the metadata item's container.
MetadataContainerScopeThe scope that the metadata item's container resides in.
MetadataModOpThe modification operation to perform on the metadata item.
MetadataNameThe name of the metadata item.
MetadataResourceIdThe Id of the resource the metadata item is associated with.
MetadataSourceNameThe name of another metadata item from which to copy or move a value.
MetadataValueThe value of the metadata item.
MetadataValueTypeThe type of the metadata item's value.
OAuthAccessTokenThe access token returned by the authorization server.
OAuthAuthorizationCodeThe authorization code that is exchanged for an access token.
OAuthAuthorizationScopeThe scope request or response parameter used during authorization.
OAuthClientIdThe id of the client assigned when registering the application.
OAuthClientProfileThe type of client that is requesting authorization.
OAuthClientSecretThe secret value for the client assigned when registering the application.
OAuthGrantTypeThe OAuth grant type used to acquire an OAuth access token.
OAuthRefreshTokenSpecifies the refresh token received from or sent to the authorization server.
OAuthReturnURLThe URL where the user (browser) returns after authenticating.
OAuthServerAuthURLThe URL of the authorization server.
OAuthServerTokenURLThe URL of the token server used to obtain the access token.
OAuthWebAuthURLThe URL to which the user should be re-directed for authorization.
OtherHeadersThis property includes other headers as determined by the user (optional).
OverwriteDetermines if local files are overwritten.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (this is the same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
QueryParamCountThe number of records in the QueryParam arrays.
QueryParamNameThe name of the query parameter.
QueryParamValueThe value of the query parameter.
ResourceDataThe data that was downloaded, or that should be uploaded.
ResourceMarkerA marker indicating what page of resources to return next.
ResourceCountThe number of records in the Resource arrays.
ResourceCreatedByThe email address of the user who created the resource.
ResourceCreatedTimeThe creation timestamp of the resource.
ResourceDescriptionA description of the resource.
ResourceETagThe ETag of the resource.
ResourceHashA SHA1 hash of the file resource's content.
ResourceIdThe Id of the resource.
ResourceModifiedByThe email address of the user who last modified the resource.
ResourceModifiedTimeThe last modified timestamp of the resource.
ResourceNameThe name of the resource.
ResourceOwnerThe email address of the user who owns the resource.
ResourceParentIdThe Id of the resource's parent.
ResourceSharedLinkThe URL of the resource's shared link.
ResourceSharedLinkAccessAccess level afforded by the resource's shared link.
ResourceSharedLinkProtectedWhether the resource's shared link is password-protected.
ResourceSizeThe size of the resource.
ResourceSyncStateThe sync state of the folder resource.
ResourceTagsTags applied to the resource.
ResourceTrashedWhether the resource is in the trash.
ResourceTrashedTimeThe trashed timestamp of the resource.
ResourceTypeThe resource's type.
ResourceVersionIdThe version Id of the file resource.
ResumeURLThe resumable upload URL.
SearchMarkerA marker indicating what page of search results to return next.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the class.
UseResumableUploadWhether to use resumable uploads.
VersionMarkerA marker indicating what page of file versions to return next.

Method List


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

AbortUploadAborts the current resumable upload session.
AddQueryParamAdds a query parameter to the QueryParams properties.
AuthorizeGet the authorization string required to access the protected resource.
CalcAuthorizationCalculates the Authorization header based on provided credentials.
ConfigSets or retrieves a configuration setting.
CopyResourceCopies a resource.
CreateFolderCreates a new folder resource.
CreateLinkCreates a shared link.
CreateMetadataCreates a new metadata container on a resource.
CreatePreviewLinkCreates a preview link.
DeleteMetadataDeletes a metadata container from a resource.
DeleteResourceTrashes or permanently deletes a resource.
DownloadFileDownloads a file resource.
GetAccountInfoGets information about the current user's account and space usage.
GetResourceInfoGets information about a specific resource.
InterruptInterrupt the current method.
ListMetadataLists the metadata items for a resource.
ListResourcesLists resources.
ListVersionsLists previous versions of a file resource.
LockFileLocks a file resource.
MoveResourceMoves a resource.
PollUploadStatusGets the status of the current resumable upload session.
PromoteVersionPromotes a previous file resource version to be the current version.
ResetResets the class to its initial state.
RestoreResourceRestores a resource from the trash.
RevokeLinkRevokes a shared link.
SearchSearches for resources that match the specified query.
SendCustomRequestSends a custom request to the Box API.
UnlockFileUnlocks a locked file resource.
UpdateMetadataUpdates the metadata items for an existing metadata container.
UpdateResourceUpdates a resource.
UploadFileUploads a new file resource.

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.

EndTransferThis event fires when a document finishes transferring.
ErrorFired when information is available about errors during data delivery.
FragmentCompleteFires after each fragment of a resumable upload is completed.
HeaderThis event is fired every time a header line comes in.
LogThis event fires once for each log message.
MetadataListFires once for each metadata item when listing a resource metadata.
ProgressFires during an upload or download to indicate transfer progress.
ResourceListFires once for each resource returned when listing resources or versions.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferThis event fires when a document starts transferring (after the headers).
TransferThis event is fired while a document transfers (delivers document).

Config Settings


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

AccountMaxFileSizeMaximum individual file size allowed for the account.
AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
ClientCreatedTimeThe client-side creation time.
ClientModifiedTimeThe client-side last modified time.
CreateLinkAccessThe access level to create links with.
CreateLinkAllowDownloadsWhether the link should permit the linked resource to be downloaded.
CreateLinkExpirationThe expiration date to assign to the link.
CreateLinkPasswordThe password to protect the link with.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EncryptionPasswordKDFThe KDF algorithm to use during password based encryption and decryption.
HashSimpleUploadsWhether to calculate and send SHA1 hashes for simple uploads.
MaxResultsLimits the number of resource and version results.
MaxSearchResultsLimits the number of search results.
MetadataUpdateOrderList of Metadata item indices specifying the order to send them in the request.
OAuthAccessTokenExpirationThe lifetime of the access token.
OAuthAuthorizationTokenTypeThe type of access token returned.
OAuthAutomaticRefreshWhether or not to refresh an expired access token automatically.
OAuthBrowserResponseTimeoutSpecifies the amount of time to wait for a response from the browser.
OAuthIncludeEmptyRedirectURIWhether an empty redirect_uri parameter is included in requests.
OAuthJWTPayloadThe payload of the JWT access token if present.
OAuthJWTXChildCountThe number of child elements of the current element.
OauthJWTXChildName[i]The name of the child element.
OAuthJWTXChildXText[i]The inner text of the child element.
OAuthJWTXElementThe name of the current element.
OauthJWTXParentThe parent of the current element.
OAuthJWTXPathProvides a way to point to a specific element in the returned payload of a JWT based access token.
OAuthJWTXSubTreeA snapshot of the current element in the document.
OAuthJWTXTextThe text of the current element.
OAuthParamCountSpecifies the number of additional parameters variables to include in the request.
OAuthParamName[i]Specifies the parameter name at the specified index.
OAuthParamValue[i]Specifies the parameter value at the specified index.
OAuthPasswordGrantUsernameUsed in the Resource Owner Password grant type.
OAuthPKCEChallengeEncodingThe PKCE code challenge method to use.
OAuthPKCEVerifierThe PKCE verifier used to generate the challenge.
OAuthReUseWebServerDetermines if the same server instance is used between requests.
OAuthUsePKCESpecifies if PKCE should be used.
OAuthWebServerActiveSpecifies and controls whether the embedded web server is active.
OAuthWebServerCertStoreThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertStorePasswordThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertStoreTypeThe certificate with private key to use when SSL is enabled.
OAuthWebServerCertSubjectThe certificate with private key to use when SSL is enabled.
OAuthWebServerFailedResponseThe custom response that will be displayed to the user if authentication failed.
OAuthWebServerHostThe hostname used by the embedded web server displayed in the ReturnURL.
OAuthWebServerPortThe local port on which the embedded web server listens.
OAuthWebServerResponseThe custom response that will be displayed to the user.
OAuthWebServerSSLEnabledWhether the web server requires SSL connections.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
ResourceClientCreatedTime[i]The client-side creation timestamp of the specified resource.
ResourceClientModifiedTime[i]The client-side last modified timestamp of the specified resource.
ResourceExpirationTime[i]The expiration timestamp of the specified resource.
ResourcePurgeTime[i]The purge timestamp of the specified resource.
ResourceSharedLinkCanDownload[i]Whether the specified resource's shared link provides download access.
ResourceSharedLinkDownloadURL[i]The shared direct download URL for the specified resource.
ResourceSharedLinkExpiration[i]The expiration timestamp of the specified resource.
RetryAfterThe number of seconds after which to retry the request.
TempPathThe path to the directory where temporary files are created.
ThumbnailFormatThe image format thumbnails should be downloaded in.
ThumbnailSizeThe thumbnail output size.
UploadExpDateThe expiration of the resumable upload session.
UploadFragmentSizeThe fragment size in use for the resumable upload session.
VersionIdA version Id, used to modify certain requests.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

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* properties, using the OAuth class or a separate process. If using the OAuth* properties, then the Authorization property will not be used.

Bearer ACCESS_TOKEN
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:

0 (bdtFileContent - default) DownloadFile will download the file's contents.
1 (bdtFileThumbnail) DownloadFile will download a thumbnail of the file.

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:

Algorithm Key Size
0 (eaAES - default) 256
1 (eaBlowfish) 448
2 (eaCAST) 128
3 (eaDES) 64
4 (eaIDEA) 128
5 (eaRC2) 128
6 (eaRC4) 2048
7 (eaTEA) 128
8 (eaTripleDES) 192
9 (eaTwofish) 256
10 (eaRijndael) 256
11 (eaChaCha) 256
12 (eaXSalsa20) 256

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)

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

Object Oriented Interface


public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface


cloudstorage_box_get($res, 18 );


cloudstorage_box_set($res, 18, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudStorage_Box Class)

This property determines 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

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


cloudstorage_box_get($res, 20 );


cloudstorage_box_set($res, 20, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface


cloudstorage_box_get($res, 21 );


cloudstorage_box_set($res, 21, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface


cloudstorage_box_get($res, 22 );


cloudstorage_box_set($res, 22, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface


cloudstorage_box_get($res, 23 );


cloudstorage_box_set($res, 23, $value );

Default Value

''

Remarks

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

Data Type

String

Idle Property (CloudStorage_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

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

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_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

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

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:

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:

0 (opNone - default) No-Op (the class skips the metadata item).
1 (opAdd) A new metadata item will be added. If one already exists with the specified MetadataName, its value will be overwritten.
2 (opReplace) The metadata item with the given MetadataName (which must already exist) will have its value overwritten.
3 (opCopyFrom) A new metadata item will be added, its value copied from the item specified by MetadataSourceName (which must already exist).
4 (opMoveFrom) A new metadata item will be added, its value moved from the item specified by MetadataSourceName (which must already exist). The source item will then be removed.
5 (opRemove) The metadata item with the given MetadataName (which must already exist) will be removed.
6 (opTest) Will verify that the metadata item with the given MetadataName (which must already exist) has the specified MetadataValue.

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:

Value Type Encoded As Corresponding Box Types
0 (mtString - default) String string, date, enum (single-select)
1 (mtNumber) Number float (note: actually any numeric value, including integers)
2 (mtMultiSelect) Array of strings enum (multi-select)

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:

0 (cocpApplication - Default)The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section.
1 (cocpWeb)The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section.

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:

0 (cogtAuthorizationCode - Default) Authorization Code grant type
1 (cogtImplicit) Implicit grant type
2 (cogtPassword) Resource Owner Password Credentials grant type
3 (cogtClientCredentials) Client Credentials grant type

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

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


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


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


cloudstorage_box_set($res, 46, $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, 47 );


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)

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

Object Oriented Interface


public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface


cloudstorage_box_get($res, 48 );


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


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


Default Value

0

Remarks

This property controls the size of the following arrays:

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, 51 , $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, 52 , $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)

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

Object Oriented Interface


public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface


cloudstorage_box_get($res, 53 );


cloudstorage_box_set($res, 53, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface


cloudstorage_box_get($res, 54 );


cloudstorage_box_set($res, 54, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface


cloudstorage_box_get($res, 55 );


cloudstorage_box_set($res, 55, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getProxyPort();


public function setProxyPort($value);

Procedural Interface


cloudstorage_box_get($res, 56 );


cloudstorage_box_set($res, 56, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (CloudStorage_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, 57 );


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

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

Object Oriented Interface


public function getProxySSL();


public function setProxySSL($value);

Procedural Interface


cloudstorage_box_get($res, 58 );


cloudstorage_box_set($res, 58, $value );

Default Value

0

Remarks

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

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getProxyUser();


public function setProxyUser($value);

Procedural Interface


cloudstorage_box_get($res, 59 );


cloudstorage_box_set($res, 59, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

QueryParamCount Property (CloudStorage_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, 60 );


cloudstorage_box_set($res, 60, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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, 61 , $queryparamindex);


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


cloudstorage_box_set($res, 62, $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, 63 );


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


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


cloudstorage_box_set($res, 65, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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, 66 , $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, 67 , $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, 68 , $resourceindex);


cloudstorage_box_set($res, 68, $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, 69 , $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, 70 , $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, 71 , $resourceindex);


cloudstorage_box_set($res, 71, $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, 72 , $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, 73 , $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, 74 , $resourceindex);


cloudstorage_box_set($res, 74, $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, 75 , $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, 76 , $resourceindex);


cloudstorage_box_set($res, 76, $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, 77 , $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, 78 , $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:

0 (slaOpen - default) Anyone can access the resource using the link.
1 (slaCompany) Only members of the company can access the resource using the link.
2 (slaCollaborators) Only members of the folder the resource is in can access the resource using the 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

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, 79 , $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, 80 , $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, 81 , $resourceindex);


cloudstorage_box_set($res, 81, $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:

0 (ssUndefined - default) The sync state is undefined. This is the only valid value for file resources, and is also used if a folder resource's sync state is unknown.
1 (ssSynced) The folder resource is fully synced.
2 (ssNotSynced) The folder resource is not synced.
3 (ssPartiallySynced) Only parts of the folder resource's contents are synced.

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, 82 , $resourceindex);


cloudstorage_box_set($res, 82, $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, 83 , $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, 84 , $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, 85 , $resourceindex);


Default Value

0

Remarks

The resource's type.

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

0 (brtFile) A file.
1 (brtFolder) A 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

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, 86 , $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, 87 );


cloudstorage_box_set($res, 87, $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, 88 );


cloudstorage_box_set($res, 88, $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

SSLAcceptServerCertEncoded Property (CloudStorage_Box Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


cloudstorage_box_get($res, 90 );


cloudstorage_box_set($res, 90, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudStorage_Box Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


cloudstorage_box_get($res, 118 );


cloudstorage_box_set($res, 118, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


cloudstorage_box_get($res, 134 );


cloudstorage_box_set($res, 134, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_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, 135 );


cloudstorage_box_set($res, 135, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (CloudStorage_Box Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


cloudstorage_box_get($res, 136 );


cloudstorage_box_set($res, 136, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (CloudStorage_Box Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


cloudstorage_box_get($res, 137 );


cloudstorage_box_set($res, 137, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (CloudStorage_Box Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


cloudstorage_box_get($res, 145 );


cloudstorage_box_set($res, 145, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
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

SSLServerCertEncoded Property (CloudStorage_Box Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


cloudstorage_box_get($res, 147 );


Default Value

''

Remarks

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

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

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

Data Type

Binary String

StartByte Property (CloudStorage_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, 174 );


cloudstorage_box_set($res, 174, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_Box Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


cloudstorage_box_get($res, 175 );


cloudstorage_box_set($res, 175, $value );

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

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


cloudstorage_box_set($res, 176, $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, 177 );


cloudstorage_box_set($res, 177, $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 QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

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

Authorize Method (CloudStorage_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* properties.

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:

// 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* items that satisfy all of the following constraints will be added to the new metadata container immediately (assuming the server returns no errors):

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

Interrupt Method (CloudStorage_Box Class)

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

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

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

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:

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:

Query Parameter Name Example Value Description
type folder Restrict results to resources of the given type.
file_extensions png,docx,pdf Restrict results to files with one of the given extensions.
ancestor_folder_ids d:12345,d:0,d:67890 Restrict results to resources within (recursively) one or more of the specified folders
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 Resource* properties.

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

The MaxSearchResults configuration setting can be used to control 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 QueryParam* properties are added to the request URL.
  2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
  3. Stores the response headers in the ParsedHeader* properties, and the response body in the specified LocalFile, or ResourceData (using the same logic as DownloadFile).

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

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 represented by the Metadata* properties has a MetadataModOp property which can be set to one of the following values:

0 (opNone - default) No-Op (the class skips the metadata item).
1 (opAdd) A new metadata item will be added. If one already exists with the specified MetadataName, its value will be overwritten.
2 (opReplace) The metadata item with the given MetadataName (which must already exist) will have its value overwritten.
3 (opCopyFrom) A new metadata item will be added, its value copied from the item specified by MetadataSourceName (which must already exist).
4 (opMoveFrom) A new metadata item will be added, its value moved from the item specified by MetadataSourceName (which must already exist). The source item will then be removed.
5 (opRemove) The metadata item with the given MetadataName (which must already exist) will be removed.
6 (opTest) Will verify that the metadata item with the given MetadataName (which must already exist) has the specified MetadataValue.

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:

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 an item in the Resource* 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 Resource* properties.
  2. Modify the item's Resource* properties as desired; the following properties are supported:
  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.)
  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)

This event is 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)

This event fires 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 fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

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

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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:

Value Type Encoded As Corresponding Box Types
0 (mtString - default) String string, date, enum (single-select)
1 (mtNumber) Number float (note: actually any numeric value, including integers)
2 (mtMultiSelect) Array of strings enum (multi-select)

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:

0 (brtFile) A file.
1 (brtFolder) A folder.

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)

This event is 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

AccountMaxFileSize:   Maximum individual file size allowed for the account.

After calling GetAccountInfo, this setting can be queried to determine the maximum individual file size, in bytes, allowed for the current account.

AccumulatePages:   Whether the class should accumulate subsequent pages of results when listing them.

This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned.

By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.

ClientCreatedTime:   The client-side creation time.

This setting may be set to an appropriately-formatted timestamp before calling UploadFile to set the client-side creation time for the file resource.

Timestamps are formatted according to RFC 3339.

ClientModifiedTime:   The client-side last modified time.

This setting may be set to an appropriately-formatted timestamp before calling UploadFile (or UpdateResource, if updating a file resource's contents) to set the client-side last modified time for the file resource.

Timestamps are formatted according to RFC 3339.

CreateLinkAccess:   The access level to create links with.

This setting specifies the access level that CreateLink should create links with. Possible values are:

0 (slaOpen - default) Anyone can access the resource using the link.
1 (slaCompany) Only members of the company can access the resource using the link.
2 (slaCollaborators) Only members of the folder the resource is in can access the resource using the link.
CreateLinkAllowDownloads:   Whether the link should permit the linked resource to be downloaded.

This setting controls whether the link created with CreateLink should permit those who have it to download the linked resource.

This setting is enabled by default; it is not applicable when CreateLinkAccess is set to 2 (slaCollaborators).

CreateLinkExpiration:   The expiration date to assign to the link.

This setting may be set to an appropriately-formatted timestamp before calling CreateLink to specify an expiration time for it. If this setting is empty (default) when CreateLink is called, the link will never expire.

Note that only paid accounts may create expiring links.

Timestamps are formatted according to RFC 3339.

CreateLinkPassword:   The password to protect the link with.

This setting may be set before calling CreateLink to protect the created link with the specified password.

Note that shared link passwords cannot be changed after the link has been created.

DownloadTempFile:   The temporary file used when downloading encrypted data.

This setting specifies the temporary file used when downloading encrypted data.

When downloading encrypted data with LocalFile set, the class will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.

If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details.

EncryptionIV:   The initialization vector to be used for encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionKey:   The key to use during encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionPasswordKDF:   The KDF algorithm to use during password based encryption and decryption.

This setting specified the Key Derivation Function (KDF) used to derive a key from the specified EncryptionPassword. Possible values are:

  • 0 (default) - PBKDF1
  • 1 - PBKDF2
Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used.

HashSimpleUploads:   Whether to calculate and send SHA1 hashes for simple uploads.

This setting controls whether the class will calculate and send SHA1 hashes of file content uploaded with UploadFile or UpdateResource when UseResumableUpload is set to false.

This setting is disabled by default for better performance. Note that SHA1 hashes are always calculated when uploading file content if UseResumableUpload is set to true.

MaxResults:   Limits the number of resource and version results.

This setting specifies the maximum number of results to be returned each time ListResources or ListVersions is called. If there are more items than can be returned, the results will be paged and the appropriate "Marker" property populated.

Acceptable values are from 1 to 1000 inclusive. The default is -1, which causes the server's default (100 for ListResources; 1000 for ListVersions) to be used.

MaxSearchResults:   Limits the number of search results.

This setting specifies the maximum number of search results to be returned each time Search is called. If there are more items than can be returned, the results will be paged and the SearchMarker property populated. Note that in some cases a page of results may have less items than is specified here, even if more pages are available.

Acceptable values are from 1 to 200 inclusive. The default is -1, which causes the server's default (30) to be used.

MetadataUpdateOrder:   List of Metadata item indices specifying the order to send them in the request.

This setting may be set to a comma-separated list of Metadata* item indices before calling UpdateMetadata to explicitly specify the order in which the class transmits the items' modification operations.

The class will skip items at missing and invalid indices; and the same item skipping logic described for UpdateMetadata applies to items at the included indices.

By default, this setting is empty, and the class will transmit the metadata item modification operations based on the order of the Metadata* items. Refer to UpdateMetadata for more information.

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

OAuthAccessTokenExpiration:   The lifetime of the access token.

This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.

OAuthAuthorizationTokenType:   The type of access token returned.

The applicable values include the following:

Bearer (default)When the access token returned by the server is a Bearer type, the authorization string returned by Authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header.
OAuthAutomaticRefresh:   Whether or not to refresh an expired access token automatically.

When this setting is set to true and the Authorization property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction.

For example, when using the Authorization Code grant type, the OAuthRefreshToken property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.

OAuthBrowserResponseTimeout:   Specifies the amount of time to wait for a response from the browser.

This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is 0, meaning that the class will wait indefinitely.

OAuthIncludeEmptyRedirectURI:   Whether an empty redirect_uri parameter is included in requests.

This setting specifies whether redirect_uri is included in the request made by Authorize if it is empty.

If set to true (default) the redirect_uri will be sent in all cases. If set to false the redirect_uri will only be sent if it has a value.

OAuthJWTPayload:   The payload of the JWT access token if present.

This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to access tokens that are returned from a service provider after successfully authorizing and authenticating with the service.

To parse the payload for specific claims, see OAuthJWTXPath.

OAuthJWTXChildCount:   The number of child elements of the current element.

The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to (OAuthJWTXChildCount - 1).

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OauthJWTXChildName[i]:   The name of the child element.

Provides the name of the i'th child element of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXChildXText[i]:   The inner text of the child element.

Provides the inner text of the i'th child element of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXElement:   The name of the current element.

Provides the name of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OauthJWTXParent:   The parent of the current element.

Provides the parent of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXPath:   Provides a way to point to a specific element in the returned payload of a JWT based access token.

The JWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.

XPath Syntax

XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

Accessor Description
name The first element with a particular name. Can be *.
[i] The i-th element.
name[i] The i-th element with a particular name.
[last()] The last element.
[last()-i] The element i before the last element.
Here are some examples of valid XPaths and some common claims:
DescriptionJSON XPath
Document root /json
Specific element /json/element_one
Username Claim (Microsoft Specific) /json/preferred_username
Registered Application Name Claim (Microsoft Specific) /json/app_displayname

This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see JWTXText.

OAuthJWTXSubTree:   A snapshot of the current element in the document.

Provides the entirety of the current element (including its sub-elements).

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthJWTXText:   The text of the current element.

Provides the inner text of the current element.

The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.

OAuthParamCount:   Specifies the number of additional parameters variables to include in the request.

This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the OAuthClientProfile is ocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance:

component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue");

Addtionally, this will also be updated to hold the parameters returned in the response.

for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName["+i+"]"); string value = component.Config("OAuthParamValue[" + i + "]"); }

OAuthParamName[i]:   Specifies the parameter name at the specified index.

This setting can be used to retrieve or specify the parameter variable name at the index specified. See OAuthParamCount for details.

OAuthParamValue[i]:   Specifies the parameter value at the specified index.

This setting can be used to retrieve or specify the parameter variable value at the index specified. See OAuthParamCount for details.

OAuthPasswordGrantUsername:   Used in the Resource Owner Password grant type.

Used to set the username property when the OAuthGrantType is set to the password grant type and Authorize is called.

OAuthPKCEChallengeEncoding:   The PKCE code challenge method to use.

This setting controls the PKCE code challenge method used when OAuthUsePKCE is set to true. Possible values are:

  • 1 (Plain)
  • 2 (S256/SHA256 - default)
OAuthPKCEVerifier:   The PKCE verifier used to generate the challenge.

This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the Authorize method and the OAuthWebAuthURL field when OAuthUsePKCE is set to true. When using the cocpWeb OAuthClientProfile, the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request.

OAuthReUseWebServer:   Determines if the same server instance is used between requests.

If set to true (default), the same embedded web server instance will be used for multiple requests. If set to false the embedded web server will be created and destroyed on each call to Authorize

OAuthUsePKCE:   Specifies if PKCE should be used.

If set to true (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code OAuthGrantType. The OAuthPKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used.

OAuthWebServerActive:   Specifies and controls whether the embedded web server is active.

The setting when queried will return the current state of the web server. If the webserver is active, it will return "true" and if it is inactive it will return "false".

This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when Authorize is called. In certain cases, it is required to start the webserver before calling Authorize. For example, if the OAuthReturnURL needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.

OAuthWebServerCertStore:   The certificate with private key to use when SSL is enabled.

The name of the certificate store used for the embedded web server's SSL.

The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.

OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStorePassword:   The certificate with private key to use when SSL is enabled.

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

Note: This is only applicable when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerCertStoreType:   The certificate with private key to use when SSL is enabled.

This specifies the type of certificate store. Possible values are:

0 User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java.
5 JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java.
6 PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
14 PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 XMLFile - The certificate store is the name of a file that contains a certificate in XML format.
17 XMLBlob - The certificate store is a string that contains a certificate in XML format.
Note: This is required when OAuthWebServerSSLEnabled is set to true.
OAuthWebServerCertSubject:   The certificate with private key to use when SSL is enabled.

The subject of the SSL certificate.

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Note: This is required when OAuthWebServerSSLEnabled is set to true.

OAuthWebServerFailedResponse:   The custom response that will be displayed to the user if authentication failed.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser.

OAuthWebServerHost:   The hostname used by the embedded web server displayed in the ReturnURL.

This setting specifies the hostname used by the embedded web server when OAuthClientProfile is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the OAuthReturnURL. This should be set to the hostname only, not the full URL.

The default value is localhost.

OAuthWebServerPort:   The local port on which the embedded web server listens.

This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server.

OAuthWebServerResponse:   The custom response that will be displayed to the user.

When Authorize is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser.

OAuthWebServerSSLEnabled:   Whether the web server requires SSL connections.

This setting specifies whether the embedded web server will use SSL. If set to True OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to False only plaintext connects are supported.

ProgressAbsolute:   Whether the class should track transfer progress absolutely.

This setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the Progress event when an interrupted transfer is resumed.

If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.

If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.

Refer to the Progress event for more information.

ProgressStep:   How often the progress event should be fired, in terms of percentage.

This setting controls how often the class will fire the Progress event during an upload or download, in terms of percentage. Valid values are 0 to 99, inclusive.

The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.

Note that the Progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were 0 for the duration of the transfer.

RawRequest:   Returns the data that was sent to the server.

This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.

RawResponse:   Returns the data that was received from the server.

This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.

ResourceClientCreatedTime[i]:   The client-side creation timestamp of the specified resource.

This setting can be queried to obtain the client-side creation timestamp for the resource at index i.

Timestamps are formatted according to RFC 3339.

Valid values for i are from 0 to (ResourceCount - 1).

ResourceClientModifiedTime[i]:   The client-side last modified timestamp of the specified resource.

This setting can be queried to obtain the client-side last modified timestamp for the resource at index i.

Timestamps are formatted according to RFC 3339.

Valid values for i are from 0 to (ResourceCount - 1).

ResourceExpirationTime[i]:   The expiration timestamp of the specified resource.

This setting can be queried to obtain the expiration timestamp for the resource at index i. Resources are deleted when they expire.

Timestamps are formatted according to RFC 3339.

Valid values for i are from 0 to (ResourceCount - 1).

ResourcePurgeTime[i]:   The purge timestamp of the specified resource.

This setting can be queried to obtain the purge timestamp (that is, the time at which the resource is permanently deleted from the trash) for the resource at index i.

Timestamps are formatted according to RFC 3339.

Valid values for i are from 0 to (ResourceCount - 1).

ResourceSharedLinkCanDownload[i]:   Whether the specified resource's shared link provides download access.

This setting can be queried to determine whether the shared link for the resource at index i allows it to be downloaded.

Valid values for i are from 0 to (ResourceCount - 1).

ResourceSharedLinkDownloadURL[i]:   The shared direct download URL for the specified resource.

This setting can be queried to obtain the shared direct download URL for the resource at index i. Only applicable for paid accounts.

Valid values for i are from 0 to (ResourceCount - 1).

ResourceSharedLinkExpiration[i]:   The expiration timestamp of the specified resource.

This setting can be queried to obtain the timestamp at which the shared link for the resource at index i expires.

Timestamps are formatted according to RFC 3339.

Valid values for i are from 0 to (ResourceCount - 1).

RetryAfter:   The number of seconds after which to retry the request.

This setting may be populated after calling DownloadFile file with DownloadType set to 1 (bdtFileThumbnail) if the server has not finished generating a thumbnail yet. The value should be interpreted as a number of seconds to wait before retrying the thumbnail download request.

TempPath:   The path to the directory where temporary files are created.

This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to DownloadTempFile and DownloadFile for more information.

ThumbnailFormat:   The image format thumbnails should be downloaded in.

When DownloadType is set to 1 (bdtFileThumbnail), this setting specifies the image format that file thumbnails will be downloaded in when DownloadFile is called. Possible values are:

0 (default) JPG
1 PNG
ThumbnailSize:   The thumbnail output size.

When DownloadType is set to 1 (bdtFileThumbnail), this setting specifies the thumbnail output size the server should use. Most sizes are only valid for one ThumbnailFormat, and should be used accordingly. Possible values are:

0 (default) 32x32 px
1 64x64 px PNG only
2 94x94 px JPG only
3 128x128 px PNG only
4 160x160 px JPG only
5 256x256 px PNG only
6 320x320 px JPG only
UploadExpDate:   The expiration of the resumable upload session.

This setting holds expiration date of the resumable upload session represented by ResumeURL. It is populated after calling PollUploadStatus.

Timestamps are formatted according to RFC 3339.

UploadFragmentSize:   The fragment size in use for the resumable upload session.

This setting holds fragment size, in bytes, in use for the resumable upload session represented by ResumeURL. It is populated after calling PollUploadStatus.

Note that this value is mandated by the server when the resumable upload session is created, and it cannot be changed.

VersionId:   A version Id, used to modify certain requests.

This setting can be set to a version Id before calling the following methods to modify their behavior:

  • CopyResource: Copies the specified version of the file resource (ignored when copying folder resources).
  • DownloadFile: Downloads the specified version of the file resource (ignored if DownloadType is set to 1 (bdtFileThumbnail)).

Note that Box only tracks file versions for paid accounts.

XChildCount:   The number of child elements of the current element.

The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildName[i]:   The name of the child element.

Provides the name of the i'th child element of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]:   The inner text of the child element.

Provides the inner text of the i'th child element of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XElement:   The name of the current element.

Provides the name of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XParent:   The parent of the current element.

Provides the parent of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.

XPath Syntax

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

Accessor Description
name The first element with a particular name. Can be *.
[i] The i-th element.
name[i] The i-th element with a particular name.
[last()] The last element.
[last()-i] The element i before the last element.
name[@attrname="attrvalue"]The first element with a particular name that contains the specified attribute-value pair.

Supports single and double quotes. (XML Only)

. The current element.
.. The parent element.
Note: XPath indices are 1-based.

XPath Examples

Assuming the following XML response:

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

Or, alternatively, the following JSON response:

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

Here are some examples of valid XPaths:

DescriptionXML XPath JSON XPath
Document root / /json
Specific element /firstlevel/one /json/firstlevel/one
i-th child /firstlevel/two/item[2]/json/firstlevel/two/[2]

This is not an exhaustive list by any means, but should provide a general idea of the possibilities.

XSubTree:   A snapshot of the current element in the document.

Provides the entirety of the current element (including its sub-elements).

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XText:   The text of the current element.

Provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

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

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (Box Class)

Common Errors

600   A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information.
601   An unsupported operation or action was attempted.
602   The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON.
603   The login credentials specified were invalid. Please refer to the error message for more information.
604   An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified.
605   An invalid index was specified.
606   An upload was aborted by the user before it could finish.
607   The specified resource is a folder and cannot be downloaded.
608   A download failed because the specified LocalFile already exists and Overwrite is false.
609   The class could not resume a download or upload. Please refer to the error message for more information.
610   An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set.
611   An exception occurred while working with the specified LocalFile (or the current value of LocalFile is invalid). Please refer to the error message for more information.
612   An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information.

Box Errors

700   A thumbnail could not be downloaded for the specified resource because the server is still in the process of generating it. Retry the request again after the number of seconds indicated by the RetryAfter configuration setting.
701   The metadata update request was aborted because none of the Metadata* items satisfied the constraints described for the UpdateMetadata method.
702   The request failed because the specified resource has been trashed.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).