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.

Syntax

Box

Remarks

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

Authentication

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

The class has the following defaults:

Below is a brief description of the different ClientProfile and GrantType 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 AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field 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 AccessToken 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 AccessToken. 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 GrantType field. 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 field 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 GrantType the class 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 class will parse the authorization code, setting the AuthorizationCode field, 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 RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

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

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this GrantType the class 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 class to ignore the values set in the OAuth property.

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

Listing Resources

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

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

Downloading Files

The DownloadFile method downloads file resources.

If 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 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 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 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). 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 class offers advanced functionality beyond simple uploads and downloads. For instance:

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Account Property (Box Class)

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

Syntax

• C++
• C
• Qt

CloudStorageBoxAccount* GetAccount();

char* cloudstorage_box_getaccountaddress(void* lpObj);

char* cloudstorage_box_getaccountcreatedtime(void* lpObj);

char* cloudstorage_box_getaccountemail(void* lpObj);

char* cloudstorage_box_getaccountenterpriseid(void* lpObj);

char* cloudstorage_box_getaccountid(void* lpObj);

char* cloudstorage_box_getaccountmodifiedtime(void* lpObj);

char* cloudstorage_box_getaccountname(void* lpObj);

char* cloudstorage_box_getaccountphone(void* lpObj);

int cloudstorage_box_getaccountrole(void* lpObj);

int cloudstorage_box_getaccountstatus(void* lpObj);

char* cloudstorage_box_getaccounttags(void* lpObj);

int64 cloudstorage_box_getaccounttotalspace(void* lpObj);

int64 cloudstorage_box_getaccountusedspace(void* lpObj);

QString GetAccountAddress();

QString GetAccountCreatedTime();

QString GetAccountEmail();

QString GetAccountEnterpriseId();

QString GetAccountId();

QString GetAccountModifiedTime();

QString GetAccountName();

QString GetAccountPhone();

int GetAccountRole();

int GetAccountStatus();

QString GetAccountTags();

qint64 GetAccountTotalSpace();

qint64 GetAccountUsedSpace();

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.

Data Type

CloudStorageBoxAccount

Authorization Property (Box Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudstorage_box_getauthorization(void* lpObj);
int cloudstorage_box_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

Data Type

String

DownloadType Property (Box Class)

The download type to use for file resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDownloadType();
int SetDownloadType(int iDownloadType);

Unicode (Windows)
INT GetDownloadType();
INT SetDownloadType(INT iDownloadType);

BDT_FILE_CONTENT(0), 
BDT_FILE_THUMBNAIL(1)

int cloudstorage_box_getdownloadtype(void* lpObj);
int cloudstorage_box_setdownloadtype(void* lpObj, int iDownloadType);

int GetDownloadType();
int SetDownloadType(int iDownloadType);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Integer

EncryptionAlgorithm Property (Box Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

EA_AES(0), 
EA_BLOWFISH(1), 
EA_CAST(2), 
EA_DES(3), 
EA_IDEA(4), 
EA_RC2(5), 
EA_RC4(6), 
EA_TEA(7), 
EA_TRIPLE_DES(8), 
EA_TWOFISH(9), 
EA_RIJNDAEL(10), 
EA_CHA_CHA(11), 
EA_XSALSA_20(12)

int cloudstorage_box_getencryptionalgorithm(void* lpObj);
int cloudstorage_box_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

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

Data Type

Integer

EncryptionPassword Property (Box Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* cloudstorage_box_getencryptionpassword(void* lpObj);
int cloudstorage_box_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

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

Firewall Property (Box Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudStorageFirewall* GetFirewall();
int SetFirewall(CloudStorageFirewall* val);

int cloudstorage_box_getfirewallautodetect(void* lpObj);
int cloudstorage_box_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_box_getfirewalltype(void* lpObj);
int cloudstorage_box_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_box_getfirewallhost(void* lpObj);
int cloudstorage_box_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_box_getfirewallpassword(void* lpObj);
int cloudstorage_box_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_box_getfirewallport(void* lpObj);
int cloudstorage_box_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_box_getfirewalluser(void* lpObj);
int cloudstorage_box_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

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

Data Type

CloudStorageFirewall

Idle Property (Box Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_box_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (Box Class)

The location of the local file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudstorage_box_getlocalfile(void* lpObj);
wchar_t* cloudstorage_box_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_box_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_box_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

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.

Data Type

String

LocalHost Property (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudstorage_box_getlocalhost(void* lpObj);
int cloudstorage_box_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

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

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

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

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

Data Type

String

Metadata Property (Box Class)

A collection of resources.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageBoxMetadata>* GetMetadata();
int SetMetadata(CloudStorageList<CloudStorageBoxMetadata>* val);

int cloudstorage_box_getmetadatacount(void* lpObj);
int cloudstorage_box_setmetadatacount(void* lpObj, int iMetadataCount);

char* cloudstorage_box_getmetadatacontainerschema(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatacontainerschema(void* lpObj, int metadataindex, const char* lpszMetadataContainerSchema);

char* cloudstorage_box_getmetadatacontainerscope(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatacontainerscope(void* lpObj, int metadataindex, const char* lpszMetadataContainerScope);

int cloudstorage_box_getmetadatamodop(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatamodop(void* lpObj, int metadataindex, int iMetadataModOp);

char* cloudstorage_box_getmetadataname(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadataname(void* lpObj, int metadataindex, const char* lpszMetadataName);

char* cloudstorage_box_getmetadataresourceid(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadataresourceid(void* lpObj, int metadataindex, const char* lpszMetadataResourceId);

char* cloudstorage_box_getmetadatasourcename(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatasourcename(void* lpObj, int metadataindex, const char* lpszMetadataSourceName);

char* cloudstorage_box_getmetadatavalue(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatavalue(void* lpObj, int metadataindex, const char* lpszMetadataValue);

int cloudstorage_box_getmetadatavaluetype(void* lpObj, int metadataindex);
int cloudstorage_box_setmetadatavaluetype(void* lpObj, int metadataindex, int iMetadataValueType);

int GetMetadataCount();
int SetMetadataCount(int iMetadataCount);

QString GetMetadataContainerSchema(int iMetadataIndex);
int SetMetadataContainerSchema(int iMetadataIndex, QString qsMetadataContainerSchema);

QString GetMetadataContainerScope(int iMetadataIndex);
int SetMetadataContainerScope(int iMetadataIndex, QString qsMetadataContainerScope);

int GetMetadataModOp(int iMetadataIndex);
int SetMetadataModOp(int iMetadataIndex, int iMetadataModOp);

QString GetMetadataName(int iMetadataIndex);
int SetMetadataName(int iMetadataIndex, QString qsMetadataName);

QString GetMetadataResourceId(int iMetadataIndex);
int SetMetadataResourceId(int iMetadataIndex, QString qsMetadataResourceId);

QString GetMetadataSourceName(int iMetadataIndex);
int SetMetadataSourceName(int iMetadataIndex, QString qsMetadataSourceName);

QString GetMetadataValue(int iMetadataIndex);
int SetMetadataValue(int iMetadataIndex, QString qsMetadataValue);

int GetMetadataValueType(int iMetadataIndex);
int SetMetadataValueType(int iMetadataIndex, int iMetadataValueType);

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.

Data Type

CloudStorageBoxMetadata

OAuth Property (Box Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudStorageOAuthSettings* GetOAuth();

char* cloudstorage_box_getoauthaccesstoken(void* lpObj);
int cloudstorage_box_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudstorage_box_getoauthauthorizationcode(void* lpObj);
int cloudstorage_box_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudstorage_box_getoauthauthorizationscope(void* lpObj);
int cloudstorage_box_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudstorage_box_getoauthclientid(void* lpObj);
int cloudstorage_box_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudstorage_box_getoauthclientprofile(void* lpObj);
int cloudstorage_box_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudstorage_box_getoauthclientsecret(void* lpObj);
int cloudstorage_box_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudstorage_box_getoauthgranttype(void* lpObj);
int cloudstorage_box_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudstorage_box_getoauthrefreshtoken(void* lpObj);
int cloudstorage_box_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudstorage_box_getoauthrequestrefreshtoken(void* lpObj);
int cloudstorage_box_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudstorage_box_getoauthreturnurl(void* lpObj);
int cloudstorage_box_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudstorage_box_getoauthserverauthurl(void* lpObj);
int cloudstorage_box_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudstorage_box_getoauthservertokenurl(void* lpObj);
int cloudstorage_box_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudstorage_box_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

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.

Data Type

CloudStorageOAuthSettings

OtherHeaders Property (Box Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudstorage_box_getotherheaders(void* lpObj);
int cloudstorage_box_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

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

Determines if local files are overwritten.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudstorage_box_getoverwrite(void* lpObj);
int cloudstorage_box_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

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

ParsedHeaders Property (Box Class)

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

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_box_getparsedheadercount(void* lpObj);

char* cloudstorage_box_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* cloudstorage_box_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

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.

Data Type

CloudStorageHeader

Proxy Property (Box Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudStorageProxy* GetProxy();
int SetProxy(CloudStorageProxy* val);

int cloudstorage_box_getproxyauthscheme(void* lpObj);
int cloudstorage_box_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_box_getproxyautodetect(void* lpObj);
int cloudstorage_box_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_box_getproxypassword(void* lpObj);
int cloudstorage_box_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_box_getproxyport(void* lpObj);
int cloudstorage_box_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_box_getproxyserver(void* lpObj);
int cloudstorage_box_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_box_getproxyssl(void* lpObj);
int cloudstorage_box_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_box_getproxyuser(void* lpObj);
int cloudstorage_box_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

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

Data Type

CloudStorageProxy

QueryParams Property (Box Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageQueryParam>* GetQueryParams();
int SetQueryParams(CloudStorageList<CloudStorageQueryParam>* val);

int cloudstorage_box_getqueryparamcount(void* lpObj);
int cloudstorage_box_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_box_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_box_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_box_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_box_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Remarks

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

Data Type

CloudStorageQueryParam

ResourceData Property (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceData(char* &lpResourceData, int &lenResourceData);
int SetResourceData(const char* lpResourceData, int lenResourceData);

Unicode (Windows)
INT GetResourceData(LPSTR &lpResourceData, INT &lenResourceData);
INT SetResourceData(LPCSTR lpResourceData, INT lenResourceData);

int cloudstorage_box_getresourcedata(void* lpObj, char** lpResourceData, int* lenResourceData);
int cloudstorage_box_setresourcedata(void* lpObj, const char* lpResourceData, int lenResourceData);

QByteArray GetResourceData();
int SetResourceData(QByteArray qbaResourceData);

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.

Data Type

Binary String

ResourceMarker Property (Box Class)

A marker indicating what page of resources to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceMarker();
int SetResourceMarker(const char* lpszResourceMarker);

Unicode (Windows)
LPWSTR GetResourceMarker();
INT SetResourceMarker(LPCWSTR lpszResourceMarker);

char* cloudstorage_box_getresourcemarker(void* lpObj);
int cloudstorage_box_setresourcemarker(void* lpObj, const char* lpszResourceMarker);

QString GetResourceMarker();
int SetResourceMarker(QString qsResourceMarker);

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

Resources Property (Box Class)

A collection of resources.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageBoxResource>* GetResources();
int SetResources(CloudStorageList<CloudStorageBoxResource>* val);

int cloudstorage_box_getresourcecount(void* lpObj);
int cloudstorage_box_setresourcecount(void* lpObj, int iResourceCount);

char* cloudstorage_box_getresourcecreatedby(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcecreatedtime(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcedescription(void* lpObj, int resourceindex);
int cloudstorage_box_setresourcedescription(void* lpObj, int resourceindex, const char* lpszResourceDescription);

char* cloudstorage_box_getresourceetag(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcehash(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourceid(void* lpObj, int resourceindex);
int cloudstorage_box_setresourceid(void* lpObj, int resourceindex, const char* lpszResourceId);

char* cloudstorage_box_getresourcemodifiedby(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcemodifiedtime(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcename(void* lpObj, int resourceindex);
int cloudstorage_box_setresourcename(void* lpObj, int resourceindex, const char* lpszResourceName);

char* cloudstorage_box_getresourceowner(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourceparentid(void* lpObj, int resourceindex);
int cloudstorage_box_setresourceparentid(void* lpObj, int resourceindex, const char* lpszResourceParentId);

char* cloudstorage_box_getresourcesharedlink(void* lpObj, int resourceindex);

int cloudstorage_box_getresourcesharedlinkaccess(void* lpObj, int resourceindex);

int cloudstorage_box_getresourcesharedlinkprotected(void* lpObj, int resourceindex);

int64 cloudstorage_box_getresourcesize(void* lpObj, int resourceindex);

int cloudstorage_box_getresourcesyncstate(void* lpObj, int resourceindex);
int cloudstorage_box_setresourcesyncstate(void* lpObj, int resourceindex, int iResourceSyncState);

char* cloudstorage_box_getresourcetags(void* lpObj, int resourceindex);
int cloudstorage_box_setresourcetags(void* lpObj, int resourceindex, const char* lpszResourceTags);

int cloudstorage_box_getresourcetrashed(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourcetrashedtime(void* lpObj, int resourceindex);

int cloudstorage_box_getresourcetype(void* lpObj, int resourceindex);

char* cloudstorage_box_getresourceversionid(void* lpObj, int resourceindex);

int GetResourceCount();
int SetResourceCount(int iResourceCount);

QString GetResourceCreatedBy(int iResourceIndex);

QString GetResourceCreatedTime(int iResourceIndex);

QString GetResourceDescription(int iResourceIndex);
int SetResourceDescription(int iResourceIndex, QString qsResourceDescription);

QString GetResourceETag(int iResourceIndex);

QString GetResourceHash(int iResourceIndex);

QString GetResourceId(int iResourceIndex);
int SetResourceId(int iResourceIndex, QString qsResourceId);

QString GetResourceModifiedBy(int iResourceIndex);

QString GetResourceModifiedTime(int iResourceIndex);

QString GetResourceName(int iResourceIndex);
int SetResourceName(int iResourceIndex, QString qsResourceName);

QString GetResourceOwner(int iResourceIndex);

QString GetResourceParentId(int iResourceIndex);
int SetResourceParentId(int iResourceIndex, QString qsResourceParentId);

QString GetResourceSharedLink(int iResourceIndex);

int GetResourceSharedLinkAccess(int iResourceIndex);

bool GetResourceSharedLinkProtected(int iResourceIndex);

qint64 GetResourceSize(int iResourceIndex);

int GetResourceSyncState(int iResourceIndex);
int SetResourceSyncState(int iResourceIndex, int iResourceSyncState);

QString GetResourceTags(int iResourceIndex);
int SetResourceTags(int iResourceIndex, QString qsResourceTags);

bool GetResourceTrashed(int iResourceIndex);

QString GetResourceTrashedTime(int iResourceIndex);

int GetResourceType(int iResourceIndex);

QString GetResourceVersionId(int iResourceIndex);

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.

Data Type

CloudStorageBoxResource

ResumeURL Property (Box Class)

The resumable upload URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResumeURL();
int SetResumeURL(const char* lpszResumeURL);

Unicode (Windows)
LPWSTR GetResumeURL();
INT SetResumeURL(LPCWSTR lpszResumeURL);

char* cloudstorage_box_getresumeurl(void* lpObj);
int cloudstorage_box_setresumeurl(void* lpObj, const char* lpszResumeURL);

QString GetResumeURL();
int SetResumeURL(QString qsResumeURL);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSearchMarker();
int SetSearchMarker(const char* lpszSearchMarker);

Unicode (Windows)
LPWSTR GetSearchMarker();
INT SetSearchMarker(LPCWSTR lpszSearchMarker);

char* cloudstorage_box_getsearchmarker(void* lpObj);
int cloudstorage_box_setsearchmarker(void* lpObj, const char* lpszSearchMarker);

QString GetSearchMarker();
int SetSearchMarker(QString qsSearchMarker);

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

SSLAcceptServerCert Property (Box Class)

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

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudStorageCertificate* val);

char* cloudstorage_box_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_box_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_box_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_box_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_box_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_box_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_box_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_box_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_box_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_box_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_box_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_box_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_box_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_box_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_box_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_box_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_box_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_box_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_box_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_box_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_box_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_box_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_box_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_box_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_box_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_box_getsslacceptservercertusage(void* lpObj);

int cloudstorage_box_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_box_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_box_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_box_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_box_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_box_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class 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.

Data Type

CloudStorageCertificate

SSLCert Property (Box Class)

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

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLCert();
int SetSSLCert(CloudStorageCertificate* val);

char* cloudstorage_box_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_box_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_box_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_box_getsslcertfingerprint(void* lpObj);

char* cloudstorage_box_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_box_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_box_getsslcertissuer(void* lpObj);

char* cloudstorage_box_getsslcertprivatekey(void* lpObj);

int cloudstorage_box_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_box_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_box_getsslcertpublickey(void* lpObj);

char* cloudstorage_box_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_box_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_box_getsslcertserialnumber(void* lpObj);

char* cloudstorage_box_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_box_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_box_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_box_getsslcertstorepassword(void* lpObj);
int cloudstorage_box_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_box_getsslcertstoretype(void* lpObj);
int cloudstorage_box_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_box_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_box_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_box_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_box_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_box_getsslcertusage(void* lpObj);

int cloudstorage_box_getsslcertusageflags(void* lpObj);

char* cloudstorage_box_getsslcertversion(void* lpObj);

char* cloudstorage_box_getsslcertsubject(void* lpObj);
int cloudstorage_box_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_box_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_box_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class 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.

Data Type

CloudStorageCertificate

SSLProvider Property (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudstorage_box_getsslprovider(void* lpObj);
int cloudstorage_box_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are as follows:

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

SSLServerCert Property (Box Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_box_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_box_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_box_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_box_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_box_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_box_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_box_getsslservercertissuer(void* lpObj);

char* cloudstorage_box_getsslservercertprivatekey(void* lpObj);

int cloudstorage_box_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_box_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_box_getsslservercertpublickey(void* lpObj);

char* cloudstorage_box_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_box_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_box_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_box_getsslservercertsignaturealgorithm(void* lpObj);

int cloudstorage_box_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudstorage_box_getsslservercertstorepassword(void* lpObj);

int cloudstorage_box_getsslservercertstoretype(void* lpObj);

char* cloudstorage_box_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_box_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_box_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_box_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_box_getsslservercertusage(void* lpObj);

int cloudstorage_box_getsslservercertusageflags(void* lpObj);

char* cloudstorage_box_getsslservercertversion(void* lpObj);

char* cloudstorage_box_getsslservercertsubject(void* lpObj);

int cloudstorage_box_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

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.

Data Type

CloudStorageCertificate

StartByte Property (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 cloudstorage_box_getstartbyte(void* lpObj);
int cloudstorage_box_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

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

Data Type

Long64

Timeout Property (Box Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudstorage_box_gettimeout(void* lpObj);
int cloudstorage_box_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseResumableUpload Property (Box Class)

Whether to use resumable uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseResumableUpload();
int SetUseResumableUpload(int bUseResumableUpload);

Unicode (Windows)
BOOL GetUseResumableUpload();
INT SetUseResumableUpload(BOOL bUseResumableUpload);

int cloudstorage_box_getuseresumableupload(void* lpObj);
int cloudstorage_box_setuseresumableupload(void* lpObj, int bUseResumableUpload);

bool GetUseResumableUpload();
int SetUseResumableUpload(bool bUseResumableUpload);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker);

Unicode (Windows)
LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);

char* cloudstorage_box_getversionmarker(void* lpObj);
int cloudstorage_box_setversionmarker(void* lpObj, const char* lpszVersionMarker);

QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);

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

Aborts the current resumable upload session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AbortUpload();

Unicode (Windows)
INT AbortUpload();

int cloudstorage_box_abortupload(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddQueryParam Method (Box Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudstorage_box_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Authorize Method (Box Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudstorage_box_authorize(void* lpObj);

int 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 field and the GrantType field. 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CalcAuthorization Method (Box Class)

Calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int cloudstorage_box_calcauthorization(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (Box Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudstorage_box_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyResource Method (Box Class)

Copies a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyResource(const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

Unicode (Windows)
LPWSTR CopyResource(LPCWSTR lpszResourceId, LPCWSTR lpszParentId, LPCWSTR lpszNewName);

char* cloudstorage_box_copyresource(void* lpObj, const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

QString CopyResource(const QString& qsResourceId, const QString& qsParentId, const QString& qsNewName);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateFolder Method (Box Class)

Creates a new folder resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateFolder(const char* lpszFolderName, const char* lpszParentId);

Unicode (Windows)
LPWSTR CreateFolder(LPCWSTR lpszFolderName, LPCWSTR lpszParentId);

char* cloudstorage_box_createfolder(void* lpObj, const char* lpszFolderName, const char* lpszParentId);

QString CreateFolder(const QString& qsFolderName, const QString& qsParentId);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateLink Method (Box Class)

Creates a shared link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateLink(const char* lpszResourceId);

Unicode (Windows)
LPWSTR CreateLink(LPCWSTR lpszResourceId);

char* cloudstorage_box_createlink(void* lpObj, const char* lpszResourceId);

QString CreateLink(const QString& qsResourceId);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateMetadata Method (Box Class)

Creates a new metadata container on a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateMetadata(const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

Unicode (Windows)
INT CreateMetadata(LPCWSTR lpszResourceId, LPCWSTR lpszScope, LPCWSTR lpszSchema);

int cloudstorage_box_createmetadata(void* lpObj, const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

int CreateMetadata(const QString& qsResourceId, const QString& qsScope, const QString& qsSchema);

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 fields must be set to 1 (opAdd).
• Their ResourceId fields must be empty, or must match the value provided for ResourceId.
• Their ContainerScope fields must be empty, or must match the value provided for Scope.
• Their ContainerSchema fields must be empty, or must match the value provided for Schema.

All applicable metadata items will have their ModOp field 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, "", "");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreatePreviewLink Method (Box Class)

Creates a preview link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreatePreviewLink(const char* lpszFileId);

Unicode (Windows)
LPWSTR CreatePreviewLink(LPCWSTR lpszFileId);

char* cloudstorage_box_createpreviewlink(void* lpObj, const char* lpszFileId);

QString CreatePreviewLink(const QString& qsFileId);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DeleteMetadata Method (Box Class)

Deletes a metadata container from a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteMetadata(const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

Unicode (Windows)
INT DeleteMetadata(LPCWSTR lpszResourceId, LPCWSTR lpszScope, LPCWSTR lpszSchema);

int cloudstorage_box_deletemetadata(void* lpObj, const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

int DeleteMetadata(const QString& qsResourceId, const QString& qsScope, const QString& qsSchema);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteResource Method (Box Class)

Trashes or permanently deletes a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteResource(const char* lpszResourceId);

Unicode (Windows)
INT DeleteResource(LPCWSTR lpszResourceId);

int cloudstorage_box_deleteresource(void* lpObj, const char* lpszResourceId);

int DeleteResource(const QString& qsResourceId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DownloadFile Method (Box Class)

Downloads a file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DownloadFile(const char* lpszFileId);

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszFileId);

int cloudstorage_box_downloadfile(void* lpObj, const char* lpszFileId);

int DownloadFile(const QString& qsFileId);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAccountInfo Method (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccountInfo();

Unicode (Windows)
INT GetAccountInfo();

int cloudstorage_box_getaccountinfo(void* lpObj);

int GetAccountInfo();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetResourceInfo Method (Box Class)

Gets information about a specific resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceInfo(const char* lpszResourceId);

Unicode (Windows)
INT GetResourceInfo(LPCWSTR lpszResourceId);

int cloudstorage_box_getresourceinfo(void* lpObj, const char* lpszResourceId);

int GetResourceInfo(const QString& qsResourceId);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (Box Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_box_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListMetadata Method (Box Class)

Lists the metadata items for a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMetadata(const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

Unicode (Windows)
INT ListMetadata(LPCWSTR lpszResourceId, LPCWSTR lpszScope, LPCWSTR lpszSchema);

int cloudstorage_box_listmetadata(void* lpObj, const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

int ListMetadata(const QString& qsResourceId, const QString& qsScope, const QString& qsSchema);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListResources Method (Box Class)

Lists resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListResources(const char* lpszFolderId);

Unicode (Windows)
INT ListResources(LPCWSTR lpszFolderId);

int cloudstorage_box_listresources(void* lpObj, const char* lpszFolderId);

int ListResources(const QString& qsFolderId);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListVersions Method (Box Class)

Lists previous versions of a file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVersions(const char* lpszFileId);

Unicode (Windows)
INT ListVersions(LPCWSTR lpszFileId);

int cloudstorage_box_listversions(void* lpObj, const char* lpszFileId);

int ListVersions(const QString& qsFileId);

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 fields are returned:

• CreatedTime
• Hash
• Id (populated by the class 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));

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LockFile Method (Box Class)

Locks a file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LockFile(const char* lpszFileId, const char* lpszExpiration, int bAllowDownloading);

Unicode (Windows)
INT LockFile(LPCWSTR lpszFileId, LPCWSTR lpszExpiration, BOOL bAllowDownloading);

int cloudstorage_box_lockfile(void* lpObj, const char* lpszFileId, const char* lpszExpiration, int bAllowDownloading);

int LockFile(const QString& qsFileId, const QString& qsExpiration, bool bAllowDownloading);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveResource Method (Box Class)

Moves a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveResource(const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

Unicode (Windows)
INT MoveResource(LPCWSTR lpszResourceId, LPCWSTR lpszParentId, LPCWSTR lpszNewName);

int cloudstorage_box_moveresource(void* lpObj, const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

int MoveResource(const QString& qsResourceId, const QString& qsParentId, const QString& qsNewName);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PollUploadStatus Method (Box Class)

Gets the status of the current resumable upload session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PollUploadStatus();

Unicode (Windows)
INT PollUploadStatus();

int cloudstorage_box_polluploadstatus(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

PromoteVersion Method (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PromoteVersion(const char* lpszFileId, const char* lpszVersionId);

Unicode (Windows)
INT PromoteVersion(LPCWSTR lpszFileId, LPCWSTR lpszVersionId);

int cloudstorage_box_promoteversion(void* lpObj, const char* lpszFileId, const char* lpszVersionId);

int PromoteVersion(const QString& qsFileId, const QString& qsVersionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (Box Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_box_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RestoreResource Method (Box Class)

Restores a resource from the trash.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RestoreResource(const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

Unicode (Windows)
INT RestoreResource(LPCWSTR lpszResourceId, LPCWSTR lpszParentId, LPCWSTR lpszNewName);

int cloudstorage_box_restoreresource(void* lpObj, const char* lpszResourceId, const char* lpszParentId, const char* lpszNewName);

int RestoreResource(const QString& qsResourceId, const QString& qsParentId, const QString& qsNewName);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RevokeLink Method (Box Class)

Revokes a shared link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RevokeLink(const char* lpszResourceId);

Unicode (Windows)
INT RevokeLink(LPCWSTR lpszResourceId);

int cloudstorage_box_revokelink(void* lpObj, const char* lpszResourceId);

int RevokeLink(const QString& qsResourceId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Search Method (Box Class)

Searches for resources that match the specified query.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Search(const char* lpszQuery);

Unicode (Windows)
INT Search(LPCWSTR lpszQuery);

int cloudstorage_box_search(void* lpObj, const char* lpszQuery);

int Search(const QString& qsQuery);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (Box Class)

Sends a custom request to the Box API.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszRequestPath, LPCWSTR lpszRequestBody);

int cloudstorage_box_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszRequestPath, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsRequestPath, const QString& qsRequestBody);

Remarks

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

Valid values for HttpMethod are:

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

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Box API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDownloadStream Method (Box Class)

Sets the stream to which downloaded data will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(CloudStorageStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(CloudStorageStream* sDownloadStream);

int cloudstorage_box_setdownloadstream(void* lpObj, CloudStorageStream* sDownloadStream);

int SetDownloadStream(CloudStorageStream* sDownloadStream);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetUploadStream Method (Box Class)

Sets the stream from which data is read when uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(CloudStorageStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(CloudStorageStream* sUploadStream);

int cloudstorage_box_setuploadstream(void* lpObj, CloudStorageStream* sUploadStream);

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UnlockFile Method (Box Class)

Unlocks a locked file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UnlockFile(const char* lpszFileId);

Unicode (Windows)
INT UnlockFile(LPCWSTR lpszFileId);

int cloudstorage_box_unlockfile(void* lpObj, const char* lpszFileId);

int UnlockFile(const QString& qsFileId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateMetadata Method (Box Class)

Updates the metadata items for an existing metadata container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateMetadata(const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

Unicode (Windows)
INT UpdateMetadata(LPCWSTR lpszResourceId, LPCWSTR lpszScope, LPCWSTR lpszSchema);

int cloudstorage_box_updatemetadata(void* lpObj, const char* lpszResourceId, const char* lpszScope, const char* lpszSchema);

int UpdateMetadata(const QString& qsResourceId, const QString& qsScope, const QString& qsSchema);

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 field which can be set to one of the following values:

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

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

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

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateResource Method (Box Class)

Updates a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateResource(const char* lpszResourceId);

Unicode (Windows)
INT UpdateResource(LPCWSTR lpszResourceId);

int cloudstorage_box_updateresource(void* lpObj, const char* lpszResourceId);

int UpdateResource(const QString& qsResourceId);

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 field 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* fields as desired; the following fields 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UploadFile Method (Box Class)

Uploads a new file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* UploadFile(const char* lpszFileName, const char* lpszParentId);

Unicode (Windows)
LPWSTR UploadFile(LPCWSTR lpszFileName, LPCWSTR lpszParentId);

char* cloudstorage_box_uploadfile(void* lpObj, const char* lpszFileName, const char* lpszParentId);

QString UploadFile(const QString& qsFileName, const QString& qsParentId);

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EndTransfer Event (Box Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(BoxEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} BoxEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(BoxEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} BoxEndTransferEventParams;

#define EID_BOX_ENDTRANSFER 1

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class BoxEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(BoxEndTransferEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireEndTransfer(BoxEndTransferEventParams *e) {...}

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

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(BoxErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} BoxErrorEventParams;


Unicode (Windows)
virtual INT FireError(BoxErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} BoxErrorEventParams;

#define EID_BOX_ERROR 2

virtual INT CLOUDSTORAGE_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class BoxErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(BoxErrorEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireError(BoxErrorEventParams *e) {...}

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

Fires after each fragment of a resumable upload is completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFragmentComplete(BoxFragmentCompleteEventParams *e);

typedef struct {
  int FragmentNumber;
  int FragmentCount;
  int Interrupt;
  int reserved;
} BoxFragmentCompleteEventParams;


Unicode (Windows)
virtual INT FireFragmentComplete(BoxFragmentCompleteEventParams *e);

typedef struct {
  INT FragmentNumber;
  INT FragmentCount;
  BOOL Interrupt;
  INT reserved;
} BoxFragmentCompleteEventParams;

#define EID_BOX_FRAGMENTCOMPLETE 3

virtual INT CLOUDSTORAGE_CALL FireFragmentComplete(INT &iFragmentNumber, INT &iFragmentCount, BOOL &bInterrupt);

class BoxFragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

  bool Interrupt();
  void SetInterrupt(bool bInterrupt);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FragmentComplete(BoxFragmentCompleteEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireFragmentComplete(BoxFragmentCompleteEventParams *e) {...}

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

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(BoxHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} BoxHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(BoxHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} BoxHeaderEventParams;

#define EID_BOX_HEADER 4

virtual INT CLOUDSTORAGE_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class BoxHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(BoxHeaderEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireHeader(BoxHeaderEventParams *e) {...}

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

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(BoxLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} BoxLogEventParams;


Unicode (Windows)
virtual INT FireLog(BoxLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} BoxLogEventParams;

#define EID_BOX_LOG 5

virtual INT CLOUDSTORAGE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class BoxLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(BoxLogEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireLog(BoxLogEventParams *e) {...}

Remarks

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

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

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

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

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

Message is the log entry.

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

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

MetadataList Event (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMetadataList(BoxMetadataListEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  int ValueType;
  const char *ContainerScope;
  const char *ContainerSchema;
  const char *ResourceId;
  int reserved;
} BoxMetadataListEventParams;


Unicode (Windows)
virtual INT FireMetadataList(BoxMetadataListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  INT ValueType;
  LPCWSTR ContainerScope;
  LPCWSTR ContainerSchema;
  LPCWSTR ResourceId;
  INT reserved;
} BoxMetadataListEventParams;

#define EID_BOX_METADATALIST 6

virtual INT CLOUDSTORAGE_CALL FireMetadataList(LPSTR &lpszName, LPSTR &lpszValue, INT &iValueType, LPSTR &lpszContainerScope, LPSTR &lpszContainerSchema, LPSTR &lpszResourceId);

class BoxMetadataListEventParams {
public:
  const QString &Name();

  const QString &Value();

  int ValueType();

  const QString &ContainerScope();

  const QString &ContainerSchema();

  const QString &ResourceId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MetadataList(BoxMetadataListEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireMetadataList(BoxMetadataListEventParams *e) {...}

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

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(BoxProgressEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int64 TotalBytes;
  int PercentDone;
  int reserved;
} BoxProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(BoxProgressEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  LONG64 TotalBytes;
  INT PercentDone;
  INT reserved;
} BoxProgressEventParams;

#define EID_BOX_PROGRESS 7

virtual INT CLOUDSTORAGE_CALL FireProgress(INT &iDirection, LONG64 &lBytesTransferred, LONG64 &lTotalBytes, INT &iPercentDone);

class BoxProgressEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  qint64 TotalBytes();

  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(BoxProgressEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireProgress(BoxProgressEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResourceList(BoxResourceListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *Description;
  int ResourceType;
  const char *CreatedTime;
  const char *ModifiedTime;
  int64 Size;
  const char *VersionId;
  const char *ETag;
  const char *Hash;
  int Trashed;
  const char *SharedLink;
  int reserved;
} BoxResourceListEventParams;


Unicode (Windows)
virtual INT FireResourceList(BoxResourceListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR Description;
  INT ResourceType;
  LPCWSTR CreatedTime;
  LPCWSTR ModifiedTime;
  LONG64 Size;
  LPCWSTR VersionId;
  LPCWSTR ETag;
  LPCWSTR Hash;
  BOOL Trashed;
  LPCWSTR SharedLink;
  INT reserved;
} BoxResourceListEventParams;

#define EID_BOX_RESOURCELIST 8

virtual INT CLOUDSTORAGE_CALL FireResourceList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszDescription, INT &iResourceType, LPSTR &lpszCreatedTime, LPSTR &lpszModifiedTime, LONG64 &lSize, LPSTR &lpszVersionId, LPSTR &lpszETag, LPSTR &lpszHash, BOOL &bTrashed, LPSTR &lpszSharedLink);

class BoxResourceListEventParams {
public:
  const QString &Id();

  const QString &Name();

  const QString &Description();

  int ResourceType();

  const QString &CreatedTime();

  const QString &ModifiedTime();

  qint64 Size();

  const QString &VersionId();

  const QString &ETag();

  const QString &Hash();

  bool Trashed();

  const QString &SharedLink();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResourceList(BoxResourceListEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireResourceList(BoxResourceListEventParams *e) {...}

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(BoxSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} BoxSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(BoxSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} BoxSSLServerAuthenticationEventParams;

#define EID_BOX_SSLSERVERAUTHENTICATION 9

virtual INT CLOUDSTORAGE_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class BoxSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(BoxSSLServerAuthenticationEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireSSLServerAuthentication(BoxSSLServerAuthenticationEventParams *e) {...}

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(BoxSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} BoxSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(BoxSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} BoxSSLStatusEventParams;

#define EID_BOX_SSLSTATUS 10

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

class BoxSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(BoxSSLStatusEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireSSLStatus(BoxSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (Box Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(BoxStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} BoxStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(BoxStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} BoxStartTransferEventParams;

#define EID_BOX_STARTTRANSFER 11

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class BoxStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(BoxStartTransferEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireStartTransfer(BoxStartTransferEventParams *e) {...}

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

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(BoxTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} BoxTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(BoxTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} BoxTransferEventParams;

#define EID_BOX_TRANSFER 12

virtual INT CLOUDSTORAGE_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class BoxTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(BoxTransferEventParams *e);

// Or, subclass Box and override this emitter function.
virtual int FireTransfer(BoxTransferEventParams *e) {...}

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.

Syntax

CloudStorageBoxAccount (declared in cloudstorage.h)

Remarks

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

Fields

Constructors

BoxAccount()

BoxMetadata Type

A Box metadata item.

Syntax

CloudStorageBoxMetadata (declared in cloudstorage.h)

Remarks

This type represents a Box metadata item.

Fields

Constructors

BoxMetadata()

BoxResource Type

A Box resource.

Syntax

CloudStorageBoxResource (declared in cloudstorage.h)

Remarks

This type represents a Box resource.

Fields