Box Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TcsBox

Remarks

The Box component 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 component requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen ClientProfile and GrantType.

The component has the following defaults:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this component. 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 component. 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 AccessToken property will be populated. Additionally, if a refresh token was provided the RefreshToken property will be populated as well. These values of the fields are for informational purposes. The component will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the component will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the component will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType 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 GrantType property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the component will use an authorization code to get an access token. For this GrantType the component expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL 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 component will parse the authorization code, setting the AuthorizationCode property, from the redirect. Immediately, the component 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 RefreshToken property is set, or a refresh token is cached, then the component will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

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

Client Credentials

When using the Client Credentials grant type, the component will act as a service instead of authorizing and authenticating as a user. This allows for the component 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 GrantType the component expects a ClientId, ClientSecret, and ServerTokenURL 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

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the component to ignore the values set in the OAuth property.

For Example: Oauth oauth = new Oauth(); oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://app.box.com/api/oauth2/authorize"; oauth.ServerTokenURL = "https://api.box.com/oauth2/token"; oauth.WebServerPort = PORT; // http://localhost:PORT needs to be a registered redirect URL for the app box.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

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

If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Resources properties every time a page of results is returned. // ResourceList event handler. box.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; do { box.ListResources("d:123456"); for (int i = 0; i < box.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(box.ResourceMarker));

Downloading Files

The DownloadFile method downloads file resources.

If a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and 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 component 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 component 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 SetUploadStream has been used to set an upload stream, it will take priority as the file data source. 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 component 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 component 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 component. 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 component 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 component is used, it should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). 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", ""); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); box.SetUploadStream(uploadStream); 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. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; box.UploadFile("MyFile.zip", "");

Additional Functionality

The Box component offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CopyResource, CreateFolder, DeleteResource, MoveResource, and RestoreResource.
• Support for resource sharing using CreateLink and RevokeLink.
• Resource metadata management with CreateMetadata, ListMetadata, UpdateMetadata, and DeleteMetadata.
• Advanced resource listing using the Search method.
• Retrieval of account and space usage details using GetAccountInfo.
• File version handling with ListVersions and PromoteVersion.
• And more!

Property List

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

Method List

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

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

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

Account Property (Box Component)

Details about the current user's account and space usage.

Syntax

property Account: TcsBoxAccount read get_Account;

Remarks

This property holds a BoxAccount object with information about the current user's account and space usage; it's populated after calling GetAccountInfo.

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

Authorization Property (Box Component)

OAuth 2.0 Authorization Token.

Syntax

property Authorization: String read get_Authorization write set_Authorization;

Default Value

''

Remarks

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

Bearer ACCESS_TOKEN

DownloadType Property (Box Component)

The download type to use for file resources.

Syntax

property DownloadType: TcsBoxDownloadTypes read get_DownloadType write set_DownloadType;

TcsBoxDownloadTypes = (
  bdtFileContent,
  bdtFileThumbnail
);

Default Value

bdtFileContent

Remarks

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

File thumbnails may be customized using the ThumbnailFormat and ThumbnailSize configuration settings. Box returns placeholder thumbnail graphics for file types it cannot generate real thumbnails for.

If Box is still in the process of generating the requested thumbnail when this method is called, the component 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.

EncryptionAlgorithm Property (Box Component)

The encryption algorithm.

Syntax

property EncryptionAlgorithm: TcsEncryptionAlgorithms read get_EncryptionAlgorithm write set_EncryptionAlgorithm;

TcsEncryptionAlgorithms = (
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
);

Default Value

eaAES

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:

EncryptionPassword Property (Box Component)

The encryption password.

Syntax

property EncryptionPassword: String read get_EncryptionPassword write set_EncryptionPassword;

Default Value

''

Remarks

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

The component 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.

Firewall Property (Box Component)

A set of properties related to firewall access.

Syntax

property Firewall: TcsFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (Box Component)

The current status of the component.

Syntax

property Idle: Boolean read get_Idle;

Default Value

true

Remarks

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

This property is read-only.

LocalFile Property (Box Component)

The location of the local file.

Syntax

property LocalFile: String read get_LocalFile write set_LocalFile;

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.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

LocalHost Property (Box Component)

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

Syntax

property LocalHost: String read get_LocalHost write set_LocalHost;

Default Value

''

Remarks

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

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

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

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

Metadata Property (Box Component)

A collection of resources.

Syntax

property Metadata: TcsBoxMetadataList read get_Metadata write set_Metadata;

Remarks

This collection holds a resource metadata items.

Calling ListMetadata will populate this collection. This collection is also used by CreateMetadata and UpdateMetadata; refer to those method for more information.

This property is not available at design time.

OAuth Property (Box Component)

This property holds the OAuth Settings.

Syntax

property OAuth: TcsOAuthSettings read get_OAuth;

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

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

OtherHeaders Property (Box Component)

Other headers as determined by the user (optional).

Syntax

property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders;

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 ('#13#10') .

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 component beyond what is provided.

This property is not available at design time.

Overwrite Property (Box Component)

Determines if local files are overwritten.

Syntax

property Overwrite: Boolean read get_Overwrite write set_Overwrite;

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.

ParsedHeaders Property (Box Component)

This property includes a collection of headers returned from the last request.

Syntax

property ParsedHeaders: TcsHeaderList read get_ParsedHeaders;

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

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

Proxy Property (Box Component)

A set of properties related to proxy access.

Syntax

property Proxy: TcsProxy read get_Proxy write set_Proxy;

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QueryParams Property (Box Component)

Additional query parameters to be included in the request.

Syntax

property QueryParams: TcsQueryParamList read get_QueryParams write set_QueryParams;

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

ResourceData Property (Box Component)

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

Syntax

property ResourceData: String read get_ResourceData write set_ResourceData;
property ResourceDataB: TBytes read get_ResourceDataB write set_ResourceDataB;

Default Value

''

Remarks

This property is populated with file data after calling DownloadFile if SetDownloadStream and LocalFile are not set.

This property can also be set before calling UploadFile; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

ResourceMarker Property (Box Component)

A marker indicating what page of resources to return next.

Syntax

property ResourceMarker: String read get_ResourceMarker write set_ResourceMarker;

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.

Resources Property (Box Component)

A collection of resources.

Syntax

property Resources: TcsBoxResourceList read get_Resources write set_Resources;

Remarks

This collection holds a list of file and folder resources.

Calling ListResources, GetResourceInfo, Search, or ListVersions will populate this collection.

This property is not available at design time.

ResumeURL Property (Box Component)

The resumable upload URL.

Syntax

property ResumeURL: String read get_ResumeURL write set_ResumeURL;

Default Value

''

Remarks

This property holds the URL of the resumable upload session. This is populated by the component 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.

SearchMarker Property (Box Component)

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

Syntax

property SearchMarker: String read get_SearchMarker write set_SearchMarker;

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.

SSLAcceptServerCert Property (Box Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

property SSLAcceptServerCert: TcsCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (Box Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

property SSLCert: TcsCertificate read get_SSLCert write set_SSLCert;

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (Box Component)

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

Syntax

property SSLProvider: TcsTSSLProviders read get_SSLProvider write set_SSLProvider;

TcsTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

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

SSLServerCert Property (Box Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TcsCertificate read get_SSLServerCert;

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StartByte Property (Box Component)

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

Syntax

property StartByte: Int64 read get_StartByte write set_StartByte;

Default Value

0

Remarks

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

When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Timeout Property (Box Component)

The timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

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 component will wait for the operation to complete before returning control.

The component 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 component raises an exception.

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

The default value for the Timeout property is 60 seconds.

UseResumableUpload Property (Box Component)

Whether to use resumable uploads.

Syntax

property UseResumableUpload: Boolean read get_UseResumableUpload write set_UseResumableUpload;

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.

VersionMarker Property (Box Component)

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

Syntax

property VersionMarker: String read get_VersionMarker write set_VersionMarker;

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.

AbortUpload Method (Box Component)

Aborts the current resumable upload session.

Syntax

procedure AbortUpload();

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 (Box Component)

Adds a query parameter to the QueryParams properties.

Syntax

procedure AddQueryParam(Name: String; Value: String);

Remarks

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

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

Authorize Method (Box Component)

Get the authorization string required to access the protected resource.

Syntax

procedure Authorize();

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 ClientProfile property and the GrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

CalcAuthorization Method (Box Component)

Calculates the Authorization header based on provided credentials.

Syntax

procedure CalcAuthorization();

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 component 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 (Box Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (Box Component)

Copies a resource.

Syntax

function CopyResource(ResourceId: String; ParentId: String; NewName: String): String;

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 (Box Component)

Creates a new folder resource.

Syntax

function CreateFolder(FolderName: String; ParentId: String): String;

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 (Box Component)

Creates a shared link.

Syntax

function CreateLink(ResourceId: String): String;

Remarks

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

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

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

• CreateLinkAccess
• CreateLinkAllowDownloads
• CreateLinkExpiration
• CreateLinkPassword

CreateMetadata Method (Box Component)

Creates a new metadata container on a resource.

Syntax

procedure CreateMetadata(ResourceId: String; Scope: String; Schema: String);

Remarks

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

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

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

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

• Their ModOp properties must be set to 1 (opAdd).
• Their ResourceId properties must be empty, or must match the value provided for ResourceId.
• Their ContainerScope properties must be empty, or must match the value provided for Scope.
• Their ContainerSchema properties must be empty, or must match the value provided for Schema.

All applicable metadata items will have their ModOp 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 component'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 component has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the component 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 (Box Component)

Creates a preview link.

Syntax

function CreatePreviewLink(FileId: String): String;

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 (Box Component)

Deletes a metadata container from a resource.

Syntax

procedure DeleteMetadata(ResourceId: String; Scope: String; Schema: String);

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 component'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 component has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the component 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 (Box Component)

Trashes or permanently deletes a resource.

Syntax

procedure DeleteResource(ResourceId: String);

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 (Box Component)

Downloads a file resource.

Syntax

procedure DownloadFile(FileId: String);

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 a stream has been specified using SetDownloadStream, the file data will be sent through it. If a stream is not specified, and 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 component 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 component 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 (Box Component)

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

Syntax

procedure GetAccountInfo();

Remarks

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

GetResourceInfo Method (Box Component)

Gets information about a specific resource.

Syntax

procedure GetResourceInfo(ResourceId: String);

Remarks

This method gets information about the resource specified by ResourceId.

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

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

Interrupt Method (Box Component)

This method interrupts the current method.

Syntax

procedure Interrupt();

Remarks

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

ListMetadata Method (Box Component)

Lists the metadata items for a resource.

Syntax

procedure ListMetadata(ResourceId: String; Scope: String; Schema: String);

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 component'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 component has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the component 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 (Box Component)

Lists resources.

Syntax

procedure ListResources(FolderId: String);

Remarks

This method lists resources within the folder specified by FolderId.

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

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

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

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

ListVersions Method (Box Component)

Lists previous versions of a file resource.

Syntax

procedure ListVersions(FileId: String);

Remarks

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

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

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

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

• CreatedTime
• Hash
• Id (populated by the component for convenience)
• ModifiedBy
• ModifiedTime
• Name
• Size
• Type (always 0 (brtFile))
• VersionId

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 (Box Component)

Locks a file resource.

Syntax

procedure LockFile(FileId: String; Expiration: String; AllowDownloading: Boolean);

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 (Box Component)

Moves a resource.

Syntax

procedure MoveResource(ResourceId: String; ParentId: String; NewName: String);

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 component times out the request based on the current value of Timeout.

PollUploadStatus Method (Box Component)

Gets the status of the current resumable upload session.

Syntax

procedure PollUploadStatus();

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 (Box Component)

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

Syntax

procedure PromoteVersion(FileId: String; VersionId: String);

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 (Box Component)

Resets the component to its initial state.

Syntax

procedure Reset();

Remarks

This method resets the component to its initial state.

RestoreResource Method (Box Component)

Restores a resource from the trash.

Syntax

procedure RestoreResource(ResourceId: String; ParentId: String; NewName: String);

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 (Box Component)

Revokes a shared link.

Syntax

procedure RevokeLink(ResourceId: String);

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 (Box Component)

Searches for resources that match the specified query.

Syntax

procedure Search(Query: String);

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:

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

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

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

SendCustomRequest Method (Box Component)

Sends a custom request to the Box API.

Syntax

procedure SendCustomRequest(HttpMethod: String; RequestPath: String; RequestBody: String);

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 component does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Box API endpoint, https://api.box.com/2.0.
   • All query parameters in the QueryParams properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeaders properties, and the response body in the stream specified using SetDownloadStream, 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.

SetDownloadStream Method (Box Component)

Sets the stream to which downloaded data will be written.

Syntax

procedure SetDownloadStream(DownloadStream: TStream);

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

SetUploadStream Method (Box Component)

Sets the stream from which data is read when uploading.

Syntax

procedure SetUploadStream(UploadStream: TStream);

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

UnlockFile Method (Box Component)

Unlocks a locked file resource.

Syntax

procedure UnlockFile(FileId: String);

Remarks

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

UpdateMetadata Method (Box Component)

Updates the metadata items for an existing metadata container.

Syntax

procedure UpdateMetadata(ResourceId: String; Scope: String; Schema: String);

Remarks

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

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

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

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

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

• Its ModOp property must not be set to 0 (opNone).
• Its ResourceId property must be empty, or must match the value provided for ResourceId.
• Its ContainerScope property must be empty, or must match the value provided for Scope.
• Its ContainerSchema property must be empty, or must match the value provided for Schema.

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

• Box applies each modification operation in the request sequentially, so the order in which they are transmitted is significant (though it may not impact all use-cases).
  • By default, the component 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 component will reset all affected metadata items' ModOp 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 component 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 ModOp 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 component'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 component has the latest metadata loaded. box.ListMetadata(resId, "global", "properties"); // Now that the component 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 (Box Component)

Updates a resource.

Syntax

procedure UpdateResource(ResourceId: String);

Remarks

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

Usage

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

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

UploadFile Method (Box Component)

Uploads a new file resource.

Syntax

function UploadFile(FileName: String; ParentId: String): String;

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 SetUploadStream has been used to set an upload stream, it will take priority as the file data source. 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 component 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 component 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 component. 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 component 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 component is used, it should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). 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", ""); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); box.SetUploadStream(uploadStream); 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. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; box.UploadFile("MyFile.zip", "");

EndTransfer Event (Box Component)

This event fires when a document finishes transferring.

Syntax

type TEndTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer;

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 (Box Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 (Box Component)

Fires after each fragment of a resumable upload is completed.

Syntax

type TFragmentCompleteEvent = procedure (
  Sender: TObject;
  FragmentNumber: Integer;
  FragmentCount: Integer;
  var Interrupt: Boolean
) of Object;

property OnFragmentComplete: TFragmentCompleteEvent read FOnFragmentComplete write FOnFragmentComplete;

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 (Box Component)

Fired every time a header line comes in.

Syntax

type THeaderEvent = procedure (
  Sender: TObject;
  const Field: String;
  const Value: String
) of Object;

property OnHeader: THeaderEvent read FOnHeader write FOnHeader;

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 (Box Component)

Fired once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

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

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

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

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

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

Message is the log entry.

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

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

MetadataList Event (Box Component)

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

Syntax

type TMetadataListEvent = procedure (
  Sender: TObject;
  const Name: String;
  const Value: String;
  ValueType: Integer;
  const ContainerScope: String;
  const ContainerSchema: String;
  const ResourceId: String
) of Object;

property OnMetadataList: TMetadataListEvent read FOnMetadataList write FOnMetadataList;

Remarks

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

Name is the name of the metadata item.

Value is the value of the metadata item.

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

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

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

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

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

Progress Event (Box Component)

Fires during an upload or download to indicate transfer progress.

Syntax

type TProgressEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  TotalBytes: Int64;
  PercentDone: Integer
) of Object;

property OnProgress: TProgressEvent read FOnProgress write FOnProgress;

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 component 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 component 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 (Box Component)

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

Syntax

type TResourceListEvent = procedure (
  Sender: TObject;
  const Id: String;
  const Name: String;
  const Description: String;
  ResourceType: Integer;
  const CreatedTime: String;
  const ModifiedTime: String;
  Size: Int64;
  const VersionId: String;
  const ETag: String;
  const Hash: String;
  Trashed: Boolean;
  const SharedLink: String
) of Object;

property OnResourceList: TResourceListEvent read FOnResourceList write FOnResourceList;

Remarks

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

Id is the Id of the resource.

Name is the name of the resource.

Description is a description of the resource.

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

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

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

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

ETag is the ETag of the resource.

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

Trashed indicates whether the resource is in the trash.

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

SSLServerAuthentication Event (Box Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

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 (Box Component)

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

Remarks

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

StartTransfer Event (Box Component)

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

Syntax

type TStartTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer
) of Object;

property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer;

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 (Box Component)

Fired while a document transfers (delivers document).

Syntax

type TTransferEvent = procedure (
  Sender: TObject;
  Direction: Integer;
  BytesTransferred: Int64;
  PercentDone: Integer;
  const Text: String;
  const TextB: TBytes
) of Object;

property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer;

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.

BoxAccount Type

A Box account's details and space usage information.

Remarks

This type represents a Box account's details and space usage information.

Fields

Constructors

constructor Create();

BoxMetadata Type

A Box metadata item.

Remarks

This type represents a Box metadata item.

Fields

Constructors

constructor Create();

BoxResource Type

A Box resource.

Remarks

This type represents a Box resource.

Fields

Constructors

constructor Create();

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

>

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TcsCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TcsCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

constructor Create();

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

constructor Create();

constructor Create(valField: String; valValue: String);

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

Used to set give the component the necessary information needed to complete OAuth authentication.

Fields

Constructors

constructor Create();

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

QueryParam Type

A query parameter to send in the request.

Remarks

This type represents a query parameter to send in the request.

Fields

Constructors

constructor Create();

constructor Create(valName: String; valValue: String);

Config Settings (Box Component)

Box Config Settings

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

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings