ShareFile Class

Properties   Methods   Events   Config Settings   Errors  

The ShareFile class makes it easy to upload, download, and manage files, folders, and share links within ShareFile.

Syntax

ShareFile

Remarks

The ShareFile class provides a simple interface for working with ShareFile. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying items, creating request and send links, and more.

Authentication

The class has the following default:

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.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL 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 access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this GrantType the class requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. 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.

Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Referencing and Creating Items, Links, Permissions, and Users

ShareFile typically uses specified ids to reference its objects. When an object is created, through methods such as CreateClient or CreateFolder or uploaded with the UploadFile method; the class will return with the objects ShareFile Id in the form of a string. In certain cases, a path (/parentFolder/ChildFolder) can be used to reference an item.

When a link is created using methods like CreateAndEmailLink , CreateAndEmailRequestLink, CreateLink, or CreateRequestLink then their URL is returned rather than their ShareFile id. To get the newly created id, the class also clears and populates the Links properties with the new link. When creating a link, you can use the CreateLinkOptions property to set certain options for the link.

When a permission is created using the CreatePermission method, the class will not return anything as ShareFile uses a combination of a UserId and the ItemId of a folder to reference permissions. When creating a permission, you can use the CreatePermissionOptions property to set certain options for the permission.

Listing and Getting Items, Links, Permissions, and Users

When listing out the Links and Users currently available to the authenticated user you will use the corresponding ListLinks and ListUsers methods. Both of these methods take no parameters and will populates their corresponding properties. For links the properties is the Links properties and for users it is the Users properties.

When listing the Items within a Folder or Permissions, the corresponding methods will take a folders ItemId. ListItems will list the items in the folder to the Items properties. The method will not recursively list out items found in child folders. The ListPermissions method will list all the permissions for the specified folder to the Permissions properties.

The class can also list out the items associated with a specified link. The ListLinkItems method will take a LinkId and populate Items properties.

The class also offers the ability to get the specific information about a certain item, link, permission, or user. GetItemInfo, GetLinkInfo and GetUserInfo each take a corresponding id. For permissions, GetPermissionInfo will take a FolderId and UserId rather than a specific id. Once called, they each clear and populate the corresponding properties.

For all list* and get* methods, there is a corresponding event that will fire for each item in the list. The ItemList event will fire when the ListItems, ListLinkItems, or GetItemInfo methods are called; the LinkList event will fire when the ListLinks or GetLinkInfo methods are called; the PermissionList event will fire when the ListPermissions or GetPermissionInfo methods are called; and the UserList event will fire when the ListUsers or GetUserInfo methods are called.

Downloading Files

The DownloadFile method downloads file or folder items.

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

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

Simple Download

A simple download is consistent with setting the LocalFile to the destination of the file when it is downloaded and then calling the method with the item's id. For example: shareFile.LocalFile = "../MyFile.zip"; shareFile.DownloadFile(shareFile.Items[0].Id);

Streaming Download

To download to a stream, first call the SetDownloadStream method and then call the DownloadFile method. For example: shareFile.LocalFile = ""; using (FileStream fs = new FileStream("../../temp/temp_data1.zip", FileMode.OpenOrCreate)) { shareFile.SetDownloadStream(fs); shareFile.DownloadFile(id); }

Uploading Files

The UploadFile method uploads new file items.

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 ItemData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

ShareFile 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, 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. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. 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. Once called and the class fragments the file, the ResumeURL property is populated. This URL needs to be set so that the class can resume the upload if the upload is interrupted.

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 and StartByte are populated (if the same instance of the class is used, they 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). 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. shareFile.UseResumableUpload = true; shareFile.LocalFile = "../MyFile.zip"; shareFile.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. shareFile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); shareFile.UseResumableUpload = true; shareFile.SetUploadStream(uploadStream); shareFile.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; shareFile.UploadFile("MyFile.zip");

Additional Functionality

The ShareFile 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 CopyItem and MoveItem.
• 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.

AccountSubdomain Property (ShareFile Class)

Represent a ShareFile domain for the account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountSubdomain();
int SetAccountSubdomain(const char* lpszAccountSubdomain);

Unicode (Windows)
LPWSTR GetAccountSubdomain();
INT SetAccountSubdomain(LPCWSTR lpszAccountSubdomain);

char* cloudstorage_sharefile_getaccountsubdomain(void* lpObj);
int cloudstorage_sharefile_setaccountsubdomain(void* lpObj, const char* lpszAccountSubdomain);

QString GetAccountSubdomain();
int SetAccountSubdomain(QString qsAccountSubdomain);

Default Value

""

Remarks

Used for making requests for accounts with subdomains. The domain is typically the account name which can be found in the admin account summary or in the URL.

For example, in https://example.sharefile.com/dashboard, 'example' represents the subdomain.

Data Type

String

Authorization Property (ShareFile 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_sharefile_getauthorization(void* lpObj);
int cloudstorage_sharefile_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

CreateLinkOptions Property (ShareFile Class)

Used to set the different options when creating a new link.

Syntax

• C++
• C
• Qt

CloudStorageShareFileLink* GetCreateLinkOptions();
int SetCreateLinkOptions(CloudStorageShareFileLink* val);

int cloudstorage_sharefile_getcreatelinkoptionsaccesslevel(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsaccesslevel(void* lpObj, int iCreateLinkOptionsAccessLevel);

char* cloudstorage_sharefile_getcreatelinkoptionscreationdate(void* lpObj);

char* cloudstorage_sharefile_getcreatelinkoptionsexpirationdate(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsexpirationdate(void* lpObj, const char* lpszCreateLinkOptionsExpirationDate);

char* cloudstorage_sharefile_getcreatelinkoptionsid(void* lpObj);

int cloudstorage_sharefile_getcreatelinkoptionsisviewonly(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsisviewonly(void* lpObj, int bCreateLinkOptionsIsViewOnly);

int cloudstorage_sharefile_getcreatelinkoptionsmaxdownloads(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsmaxdownloads(void* lpObj, int iCreateLinkOptionsMaxDownloads);

int cloudstorage_sharefile_getcreatelinkoptionsnotifyonaccess(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionsnotifyonaccess(void* lpObj, int bCreateLinkOptionsNotifyOnAccess);

char* cloudstorage_sharefile_getcreatelinkoptionstitle(void* lpObj);
int cloudstorage_sharefile_setcreatelinkoptionstitle(void* lpObj, const char* lpszCreateLinkOptionsTitle);

int cloudstorage_sharefile_getcreatelinkoptionstotaldownloads(void* lpObj);

int cloudstorage_sharefile_getcreatelinkoptionstype(void* lpObj);

char* cloudstorage_sharefile_getcreatelinkoptionsurl(void* lpObj);

int GetCreateLinkOptionsAccessLevel();
int SetCreateLinkOptionsAccessLevel(int iCreateLinkOptionsAccessLevel);

QString GetCreateLinkOptionsCreationDate();

QString GetCreateLinkOptionsExpirationDate();
int SetCreateLinkOptionsExpirationDate(QString qsCreateLinkOptionsExpirationDate);

QString GetCreateLinkOptionsId();

bool GetCreateLinkOptionsIsViewOnly();
int SetCreateLinkOptionsIsViewOnly(bool bCreateLinkOptionsIsViewOnly);

int GetCreateLinkOptionsMaxDownloads();
int SetCreateLinkOptionsMaxDownloads(int iCreateLinkOptionsMaxDownloads);

bool GetCreateLinkOptionsNotifyOnAccess();
int SetCreateLinkOptionsNotifyOnAccess(bool bCreateLinkOptionsNotifyOnAccess);

QString GetCreateLinkOptionsTitle();
int SetCreateLinkOptionsTitle(QString qsCreateLinkOptionsTitle);

int GetCreateLinkOptionsTotalDownloads();

int GetCreateLinkOptionsType();

QString GetCreateLinkOptionsURL();

Remarks

Used to set the different options when creating a new ShareFileLink. These options can be set:

• AccessLevel
• ExpirationDate
• IsViewOnly*
• MaxDownloads
• NotifyOnAccess
• Title

This property is not available at design time.

Data Type

CloudStorageShareFileLink

CreatePermissionOptions Property (ShareFile Class)

Used to set the different options when creating a new permission.

Syntax

• C++
• C
• Qt

CloudStorageShareFilePermission* GetCreatePermissionOptions();
int SetCreatePermissionOptions(CloudStorageShareFilePermission* val);

int cloudstorage_sharefile_getcreatepermissionoptionscandelete(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscandelete(void* lpObj, int bCreatePermissionOptionsCanDelete);

int cloudstorage_sharefile_getcreatepermissionoptionscandownload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscandownload(void* lpObj, int bCreatePermissionOptionsCanDownload);

int cloudstorage_sharefile_getcreatepermissionoptionscanmanagepermissions(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanmanagepermissions(void* lpObj, int bCreatePermissionOptionsCanManagePermissions);

int cloudstorage_sharefile_getcreatepermissionoptionscanupload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanupload(void* lpObj, int bCreatePermissionOptionsCanUpload);

int cloudstorage_sharefile_getcreatepermissionoptionscanview(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionscanview(void* lpObj, int bCreatePermissionOptionsCanView);

char* cloudstorage_sharefile_getcreatepermissionoptionsfolderid(void* lpObj);

int cloudstorage_sharefile_getcreatepermissionoptionsisowner(void* lpObj);

int cloudstorage_sharefile_getcreatepermissionoptionsnotifyondownload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionsnotifyondownload(void* lpObj, int bCreatePermissionOptionsNotifyOnDownload);

int cloudstorage_sharefile_getcreatepermissionoptionsnotifyonupload(void* lpObj);
int cloudstorage_sharefile_setcreatepermissionoptionsnotifyonupload(void* lpObj, int bCreatePermissionOptionsNotifyOnUpload);

char* cloudstorage_sharefile_getcreatepermissionoptionsuserid(void* lpObj);

bool GetCreatePermissionOptionsCanDelete();
int SetCreatePermissionOptionsCanDelete(bool bCreatePermissionOptionsCanDelete);

bool GetCreatePermissionOptionsCanDownload();
int SetCreatePermissionOptionsCanDownload(bool bCreatePermissionOptionsCanDownload);

bool GetCreatePermissionOptionsCanManagePermissions();
int SetCreatePermissionOptionsCanManagePermissions(bool bCreatePermissionOptionsCanManagePermissions);

bool GetCreatePermissionOptionsCanUpload();
int SetCreatePermissionOptionsCanUpload(bool bCreatePermissionOptionsCanUpload);

bool GetCreatePermissionOptionsCanView();
int SetCreatePermissionOptionsCanView(bool bCreatePermissionOptionsCanView);

QString GetCreatePermissionOptionsFolderId();

bool GetCreatePermissionOptionsIsOwner();

bool GetCreatePermissionOptionsNotifyOnDownload();
int SetCreatePermissionOptionsNotifyOnDownload(bool bCreatePermissionOptionsNotifyOnDownload);

bool GetCreatePermissionOptionsNotifyOnUpload();
int SetCreatePermissionOptionsNotifyOnUpload(bool bCreatePermissionOptionsNotifyOnUpload);

QString GetCreatePermissionOptionsUserId();

Remarks

Used to set the different options when creating a new permission. If CanDownload is set to true, CanView will automatically be set to true. If CanDownload is set to false, CanDelete will be set to false. These options can be set:

• CanDelete
• CanDownload
• CanManagePermissions
• CanUpload
• CanView
• NotifyOnDownload
• NotifyOnUpload

This property is not available at design time.

Data Type

CloudStorageShareFilePermission

EncryptionAlgorithm Property (ShareFile 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_sharefile_getencryptionalgorithm(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile 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_sharefile_getencryptionpassword(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int cloudstorage_sharefile_getfirewallautodetect(void* lpObj);
int cloudstorage_sharefile_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_sharefile_getfirewalltype(void* lpObj);
int cloudstorage_sharefile_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_sharefile_getfirewallhost(void* lpObj);
int cloudstorage_sharefile_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_sharefile_getfirewallpassword(void* lpObj);
int cloudstorage_sharefile_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_sharefile_getfirewallport(void* lpObj);
int cloudstorage_sharefile_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_sharefile_getfirewalluser(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

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

ItemData Property (ShareFile Class)

The data that was downloaded, or that should be uploaded by the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemData(char* &lpItemData, int &lenItemData);
int SetItemData(const char* lpItemData, int lenItemData);

Unicode (Windows)
INT GetItemData(LPSTR &lpItemData, INT &lenItemData);
INT SetItemData(LPCSTR lpItemData, INT lenItemData);

int cloudstorage_sharefile_getitemdata(void* lpObj, char** lpItemData, int* lenItemData);
int cloudstorage_sharefile_setitemdata(void* lpObj, const char* lpItemData, int lenItemData);

QByteArray GetItemData();
int SetItemData(QByteArray qbaItemData);

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

Items Property (ShareFile Class)

A properties of items.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageShareFileItem>* GetItems();
int SetItems(CloudStorageList<CloudStorageShareFileItem>* val);

int cloudstorage_sharefile_getitemcount(void* lpObj);
int cloudstorage_sharefile_setitemcount(void* lpObj, int iItemCount);

char* cloudstorage_sharefile_getitemcreationdate(void* lpObj, int itemindex);

char* cloudstorage_sharefile_getitemcreatorfirstname(void* lpObj, int itemindex);

char* cloudstorage_sharefile_getitemcreatorlastname(void* lpObj, int itemindex);

char* cloudstorage_sharefile_getitemdescription(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemdescription(void* lpObj, int itemindex, const char* lpszItemDescription);

char* cloudstorage_sharefile_getitemexpirationdate(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemexpirationdate(void* lpObj, int itemindex, const char* lpszItemExpirationDate);

char* cloudstorage_sharefile_getitemid(void* lpObj, int itemindex);

char* cloudstorage_sharefile_getitemname(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemname(void* lpObj, int itemindex, const char* lpszItemName);

char* cloudstorage_sharefile_getitemparentid(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitemparentid(void* lpObj, int itemindex, const char* lpszItemParentId);

char* cloudstorage_sharefile_getitempath(void* lpObj, int itemindex);
int cloudstorage_sharefile_setitempath(void* lpObj, int itemindex, const char* lpszItemPath);

int64 cloudstorage_sharefile_getitemsize(void* lpObj, int itemindex);

int cloudstorage_sharefile_getitemtype(void* lpObj, int itemindex);

int GetItemCount();
int SetItemCount(int iItemCount);

QString GetItemCreationDate(int iItemIndex);

QString GetItemCreatorFirstName(int iItemIndex);

QString GetItemCreatorLastName(int iItemIndex);

QString GetItemDescription(int iItemIndex);
int SetItemDescription(int iItemIndex, QString qsItemDescription);

QString GetItemExpirationDate(int iItemIndex);
int SetItemExpirationDate(int iItemIndex, QString qsItemExpirationDate);

QString GetItemId(int iItemIndex);

QString GetItemName(int iItemIndex);
int SetItemName(int iItemIndex, QString qsItemName);

QString GetItemParentId(int iItemIndex);
int SetItemParentId(int iItemIndex, QString qsItemParentId);

QString GetItemPath(int iItemIndex);
int SetItemPath(int iItemIndex, QString qsItemPath);

qint64 GetItemSize(int iItemIndex);

int GetItemType(int iItemIndex);

Remarks

This properties holds a list of file and folder items.

Calling ListItems , ListLinkItems or GetItemInfo will populate this properties.

This property is not available at design time.

Data Type

CloudStorageShareFileItem

Links Property (ShareFile Class)

A properties of links.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageShareFileLink>* GetLinks();
int SetLinks(CloudStorageList<CloudStorageShareFileLink>* val);

int cloudstorage_sharefile_getlinkcount(void* lpObj);
int cloudstorage_sharefile_setlinkcount(void* lpObj, int iLinkCount);

int cloudstorage_sharefile_getlinkaccesslevel(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkaccesslevel(void* lpObj, int linkindex, int iLinkAccessLevel);

char* cloudstorage_sharefile_getlinkcreationdate(void* lpObj, int linkindex);

char* cloudstorage_sharefile_getlinkexpirationdate(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkexpirationdate(void* lpObj, int linkindex, const char* lpszLinkExpirationDate);

char* cloudstorage_sharefile_getlinkid(void* lpObj, int linkindex);

int cloudstorage_sharefile_getlinkisviewonly(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkisviewonly(void* lpObj, int linkindex, int bLinkIsViewOnly);

int cloudstorage_sharefile_getlinkmaxdownloads(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinkmaxdownloads(void* lpObj, int linkindex, int iLinkMaxDownloads);

int cloudstorage_sharefile_getlinknotifyonaccess(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinknotifyonaccess(void* lpObj, int linkindex, int bLinkNotifyOnAccess);

char* cloudstorage_sharefile_getlinktitle(void* lpObj, int linkindex);
int cloudstorage_sharefile_setlinktitle(void* lpObj, int linkindex, const char* lpszLinkTitle);

int cloudstorage_sharefile_getlinktotaldownloads(void* lpObj, int linkindex);

int cloudstorage_sharefile_getlinktype(void* lpObj, int linkindex);

char* cloudstorage_sharefile_getlinkurl(void* lpObj, int linkindex);

int GetLinkCount();
int SetLinkCount(int iLinkCount);

int GetLinkAccessLevel(int iLinkIndex);
int SetLinkAccessLevel(int iLinkIndex, int iLinkAccessLevel);

QString GetLinkCreationDate(int iLinkIndex);

QString GetLinkExpirationDate(int iLinkIndex);
int SetLinkExpirationDate(int iLinkIndex, QString qsLinkExpirationDate);

QString GetLinkId(int iLinkIndex);

bool GetLinkIsViewOnly(int iLinkIndex);
int SetLinkIsViewOnly(int iLinkIndex, bool bLinkIsViewOnly);

int GetLinkMaxDownloads(int iLinkIndex);
int SetLinkMaxDownloads(int iLinkIndex, int iLinkMaxDownloads);

bool GetLinkNotifyOnAccess(int iLinkIndex);
int SetLinkNotifyOnAccess(int iLinkIndex, bool bLinkNotifyOnAccess);

QString GetLinkTitle(int iLinkIndex);
int SetLinkTitle(int iLinkIndex, QString qsLinkTitle);

int GetLinkTotalDownloads(int iLinkIndex);

int GetLinkType(int iLinkIndex);

QString GetLinkURL(int iLinkIndex);

Remarks

This properties holds a list of links.

Calling ListLinks or GetLinkInfo will populate this properties.

This property is not available at design time.

Data Type

CloudStorageShareFileLink

LocalFile Property (ShareFile 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_sharefile_getlocalfile(void* lpObj);
wchar_t* cloudstorage_sharefile_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_sharefile_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_sharefile_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 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 (ShareFile 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_sharefile_getlocalhost(void* lpObj);
int cloudstorage_sharefile_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

OAuth Property (ShareFile Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudStorageOAuthSettings* GetOAuth();

char* cloudstorage_sharefile_getoauthaccesstoken(void* lpObj);
int cloudstorage_sharefile_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudstorage_sharefile_getoauthauthorizationcode(void* lpObj);
int cloudstorage_sharefile_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudstorage_sharefile_getoauthauthorizationscope(void* lpObj);
int cloudstorage_sharefile_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudstorage_sharefile_getoauthclientid(void* lpObj);
int cloudstorage_sharefile_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudstorage_sharefile_getoauthclientprofile(void* lpObj);
int cloudstorage_sharefile_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudstorage_sharefile_getoauthclientsecret(void* lpObj);
int cloudstorage_sharefile_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudstorage_sharefile_getoauthgranttype(void* lpObj);
int cloudstorage_sharefile_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudstorage_sharefile_getoauthrefreshtoken(void* lpObj);
int cloudstorage_sharefile_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudstorage_sharefile_getoauthrequestrefreshtoken(void* lpObj);
int cloudstorage_sharefile_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudstorage_sharefile_getoauthreturnurl(void* lpObj);
int cloudstorage_sharefile_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudstorage_sharefile_getoauthserverauthurl(void* lpObj);
int cloudstorage_sharefile_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudstorage_sharefile_getoauthservertokenurl(void* lpObj);
int cloudstorage_sharefile_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudstorage_sharefile_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 (ShareFile 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_sharefile_getotherheaders(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

Whether to overwrite the local or remote file.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_sharefile_getoverwrite(void* lpObj);
int cloudstorage_sharefile_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling UploadFile, this property determines if the remote file should be if it already exists.

Note: This setting is not currently respected by the ShareFile service for file uploads. If the file has file versioning turned on it will retain the previous version. If the file versioning is turned off, the file will always be overwritten.

Data Type

Boolean

ParsedHeaders Property (ShareFile Class)

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

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_sharefile_getparsedheadercount(void* lpObj);

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

char* cloudstorage_sharefile_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

Permissions Property (ShareFile Class)

A properties of permissions.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageShareFilePermission>* GetPermissions();
int SetPermissions(CloudStorageList<CloudStorageShareFilePermission>* val);

int cloudstorage_sharefile_getpermissioncount(void* lpObj);
int cloudstorage_sharefile_setpermissioncount(void* lpObj, int iPermissionCount);

int cloudstorage_sharefile_getpermissioncandelete(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncandelete(void* lpObj, int permissionindex, int bPermissionCanDelete);

int cloudstorage_sharefile_getpermissioncandownload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncandownload(void* lpObj, int permissionindex, int bPermissionCanDownload);

int cloudstorage_sharefile_getpermissioncanmanagepermissions(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanmanagepermissions(void* lpObj, int permissionindex, int bPermissionCanManagePermissions);

int cloudstorage_sharefile_getpermissioncanupload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanupload(void* lpObj, int permissionindex, int bPermissionCanUpload);

int cloudstorage_sharefile_getpermissioncanview(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissioncanview(void* lpObj, int permissionindex, int bPermissionCanView);

char* cloudstorage_sharefile_getpermissionfolderid(void* lpObj, int permissionindex);

int cloudstorage_sharefile_getpermissionisowner(void* lpObj, int permissionindex);

int cloudstorage_sharefile_getpermissionnotifyondownload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissionnotifyondownload(void* lpObj, int permissionindex, int bPermissionNotifyOnDownload);

int cloudstorage_sharefile_getpermissionnotifyonupload(void* lpObj, int permissionindex);
int cloudstorage_sharefile_setpermissionnotifyonupload(void* lpObj, int permissionindex, int bPermissionNotifyOnUpload);

char* cloudstorage_sharefile_getpermissionuserid(void* lpObj, int permissionindex);

int GetPermissionCount();
int SetPermissionCount(int iPermissionCount);

bool GetPermissionCanDelete(int iPermissionIndex);
int SetPermissionCanDelete(int iPermissionIndex, bool bPermissionCanDelete);

bool GetPermissionCanDownload(int iPermissionIndex);
int SetPermissionCanDownload(int iPermissionIndex, bool bPermissionCanDownload);

bool GetPermissionCanManagePermissions(int iPermissionIndex);
int SetPermissionCanManagePermissions(int iPermissionIndex, bool bPermissionCanManagePermissions);

bool GetPermissionCanUpload(int iPermissionIndex);
int SetPermissionCanUpload(int iPermissionIndex, bool bPermissionCanUpload);

bool GetPermissionCanView(int iPermissionIndex);
int SetPermissionCanView(int iPermissionIndex, bool bPermissionCanView);

QString GetPermissionFolderId(int iPermissionIndex);

bool GetPermissionIsOwner(int iPermissionIndex);

bool GetPermissionNotifyOnDownload(int iPermissionIndex);
int SetPermissionNotifyOnDownload(int iPermissionIndex, bool bPermissionNotifyOnDownload);

bool GetPermissionNotifyOnUpload(int iPermissionIndex);
int SetPermissionNotifyOnUpload(int iPermissionIndex, bool bPermissionNotifyOnUpload);

QString GetPermissionUserId(int iPermissionIndex);

Remarks

This properties holds a list of permissions.

Calling ListPermissions or GetPermissionInfo will populate this properties.

This property is not available at design time.

Data Type

CloudStorageShareFilePermission

Proxy Property (ShareFile Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

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

int cloudstorage_sharefile_getproxyauthscheme(void* lpObj);
int cloudstorage_sharefile_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_sharefile_getproxyautodetect(void* lpObj);
int cloudstorage_sharefile_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_sharefile_getproxypassword(void* lpObj);
int cloudstorage_sharefile_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_sharefile_getproxyport(void* lpObj);
int cloudstorage_sharefile_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_sharefile_getproxyserver(void* lpObj);
int cloudstorage_sharefile_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_sharefile_getproxyssl(void* lpObj);
int cloudstorage_sharefile_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_sharefile_getproxyuser(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

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

int cloudstorage_sharefile_getqueryparamcount(void* lpObj);
int cloudstorage_sharefile_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_sharefile_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_sharefile_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_sharefile_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_sharefile_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

ResumeURL Property (ShareFile 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_sharefile_getresumeurl(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

A marker indicating the number of search results to skip next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSearchMarker();
int SetSearchMarker(int iSearchMarker);

Unicode (Windows)
INT GetSearchMarker();
INT SetSearchMarker(INT iSearchMarker);

int cloudstorage_sharefile_getsearchmarker(void* lpObj);
int cloudstorage_sharefile_setsearchmarker(void* lpObj, int iSearchMarker);

int GetSearchMarker();
int SetSearchMarker(int iSearchMarker);

Default Value

0

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

Refer to Search for more information.

Note: Currently, ShareFile does not support the search functionality.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCert Property (ShareFile 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_sharefile_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_sharefile_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_sharefile_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_sharefile_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_sharefile_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_sharefile_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_sharefile_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_sharefile_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_sharefile_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_sharefile_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertusage(void* lpObj);

int cloudstorage_sharefile_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_sharefile_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_sharefile_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_sharefile_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_sharefile_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 (ShareFile Class)

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

Syntax

• C++
• C
• Qt

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

char* cloudstorage_sharefile_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_sharefile_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_sharefile_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_sharefile_getsslcertfingerprint(void* lpObj);

char* cloudstorage_sharefile_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslcertissuer(void* lpObj);

char* cloudstorage_sharefile_getsslcertprivatekey(void* lpObj);

int cloudstorage_sharefile_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_sharefile_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_sharefile_getsslcertpublickey(void* lpObj);

char* cloudstorage_sharefile_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_sharefile_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_sharefile_getsslcertserialnumber(void* lpObj);

char* cloudstorage_sharefile_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_sharefile_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_sharefile_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_sharefile_getsslcertstorepassword(void* lpObj);
int cloudstorage_sharefile_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_sharefile_getsslcertstoretype(void* lpObj);
int cloudstorage_sharefile_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_sharefile_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_sharefile_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_sharefile_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslcertusage(void* lpObj);

int cloudstorage_sharefile_getsslcertusageflags(void* lpObj);

char* cloudstorage_sharefile_getsslcertversion(void* lpObj);

char* cloudstorage_sharefile_getsslcertsubject(void* lpObj);
int cloudstorage_sharefile_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_sharefile_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_sharefile_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 (ShareFile 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_sharefile_getsslprovider(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_sharefile_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_sharefile_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_sharefile_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_sharefile_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_sharefile_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslservercertissuer(void* lpObj);

char* cloudstorage_sharefile_getsslservercertprivatekey(void* lpObj);

int cloudstorage_sharefile_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_sharefile_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_sharefile_getsslservercertpublickey(void* lpObj);

char* cloudstorage_sharefile_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_sharefile_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_sharefile_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_sharefile_getsslservercertsignaturealgorithm(void* lpObj);

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

char* cloudstorage_sharefile_getsslservercertstorepassword(void* lpObj);

int cloudstorage_sharefile_getsslservercertstoretype(void* lpObj);

char* cloudstorage_sharefile_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_sharefile_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_sharefile_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_sharefile_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_sharefile_getsslservercertusage(void* lpObj);

int cloudstorage_sharefile_getsslservercertusageflags(void* lpObj);

char* cloudstorage_sharefile_getsslservercertversion(void* lpObj);

char* cloudstorage_sharefile_getsslservercertsubject(void* lpObj);

int cloudstorage_sharefile_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 (ShareFile 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_sharefile_getstartbyte(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile 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_sharefile_gettimeout(void* lpObj);
int cloudstorage_sharefile_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 (ShareFile 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_sharefile_getuseresumableupload(void* lpObj);
int cloudstorage_sharefile_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

Users Property (ShareFile Class)

A properties of users.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageShareFileUser>* GetUsers();
int SetUsers(CloudStorageList<CloudStorageShareFileUser>* val);

int cloudstorage_sharefile_getusercount(void* lpObj);
int cloudstorage_sharefile_setusercount(void* lpObj, int iUserCount);

char* cloudstorage_sharefile_getusercompany(void* lpObj, int userindex);
int cloudstorage_sharefile_setusercompany(void* lpObj, int userindex, const char* lpszUserCompany);

char* cloudstorage_sharefile_getusercreationdate(void* lpObj, int userindex);

char* cloudstorage_sharefile_getuseremail(void* lpObj, int userindex);
int cloudstorage_sharefile_setuseremail(void* lpObj, int userindex, const char* lpszUserEmail);

char* cloudstorage_sharefile_getuserfirstname(void* lpObj, int userindex);
int cloudstorage_sharefile_setuserfirstname(void* lpObj, int userindex, const char* lpszUserFirstName);

char* cloudstorage_sharefile_getuserid(void* lpObj, int userindex);

char* cloudstorage_sharefile_getuserlastname(void* lpObj, int userindex);
int cloudstorage_sharefile_setuserlastname(void* lpObj, int userindex, const char* lpszUserLastName);

int GetUserCount();
int SetUserCount(int iUserCount);

QString GetUserCompany(int iUserIndex);
int SetUserCompany(int iUserIndex, QString qsUserCompany);

QString GetUserCreationDate(int iUserIndex);

QString GetUserEmail(int iUserIndex);
int SetUserEmail(int iUserIndex, QString qsUserEmail);

QString GetUserFirstName(int iUserIndex);
int SetUserFirstName(int iUserIndex, QString qsUserFirstName);

QString GetUserId(int iUserIndex);

QString GetUserLastName(int iUserIndex);
int SetUserLastName(int iUserIndex, QString qsUserLastName);

Remarks

This properties holds a list of users.

Calling ListUsers or GetUserInfo will populate this properties.

This property is not available at design time.

Data Type

CloudStorageShareFileUser

AddQueryParam Method (ShareFile 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_sharefile_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 (ShareFile 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_sharefile_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 (ShareFile Class)

Calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int cloudstorage_sharefile_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 (ShareFile 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_sharefile_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.

CopyItem Method (ShareFile Class)

Copies the specified item into the specified directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyItem(const char* lpszItemId, const char* lpszParentId);

Unicode (Windows)
LPWSTR CopyItem(LPCWSTR lpszItemId, LPCWSTR lpszParentId);

char* cloudstorage_sharefile_copyitem(void* lpObj, const char* lpszItemId, const char* lpszParentId);

QString CopyItem(const QString& qsItemId, const QString& qsParentId);

Remarks

This method copies the file identified by ItemId to the directory specified by ParentId and returns the Id of the newly created copy. Must call ListItems or GetItemInfo before the Items properties will be updated with the copied item.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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.

CreateAndEmailLink Method (ShareFile Class)

Creates a link for specified items and emails it.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateAndEmailLink(const char* lpszItemIds, const char* lpszemails, const char* lpszsubject, const char* lpsznote);

Unicode (Windows)
LPWSTR CreateAndEmailLink(LPCWSTR lpszItemIds, LPCWSTR lpszemails, LPCWSTR lpszsubject, LPCWSTR lpsznote);

char* cloudstorage_sharefile_createandemaillink(void* lpObj, const char* lpszItemIds, const char* lpszemails, const char* lpszsubject, const char* lpsznote);

QString CreateAndEmailLink(const QString& qsItemIds, const QString& qsemails, const QString& qssubject, const QString& qsnote);

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new link. After doing so it will also send the emails with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note is added as a note within the body of the email. CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a ItemIds to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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.

CreateAndEmailRequestLink Method (ShareFile Class)

Creates a new request link and emails it to the specified emails.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateAndEmailRequestLink(const char* lpszFolderId, const char* lpszemails, const char* lpszsubject, const char* lpsznote);

Unicode (Windows)
LPWSTR CreateAndEmailRequestLink(LPCWSTR lpszFolderId, LPCWSTR lpszemails, LPCWSTR lpszsubject, LPCWSTR lpsznote);

char* cloudstorage_sharefile_createandemailrequestlink(void* lpObj, const char* lpszFolderId, const char* lpszemails, const char* lpszsubject, const char* lpsznote);

QString CreateAndEmailRequestLink(const QString& qsFolderId, const QString& qsemails, const QString& qssubject, const QString& qsnote);

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new request link. After doing so it will also send the emails with the new request link. FolderId is the ID of the directory where the files will be uploaded in ShareFile. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note id added as a note within the body of the email. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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.

CreateClient Method (ShareFile Class)

Creates a new client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateClient(const char* lpszFirstName, const char* lpszLastName, const char* lpszEmail, const char* lpszCompany);

Unicode (Windows)
LPWSTR CreateClient(LPCWSTR lpszFirstName, LPCWSTR lpszLastName, LPCWSTR lpszEmail, LPCWSTR lpszCompany);

char* cloudstorage_sharefile_createclient(void* lpObj, const char* lpszFirstName, const char* lpszLastName, const char* lpszEmail, const char* lpszCompany);

QString CreateClient(const QString& qsFirstName, const QString& qsLastName, const QString& qsEmail, const QString& qsCompany);

Remarks

Creates a new client user and returns the new client id as a string. The Users properties will not be updated with the new client until the ListUsers or GetUserInfo methods are called. FirstName, LastName, and Email are required to create a client. Company can be left empty. // Creates a client named John Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("John", "Brown", "example@example.com", "");

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

Creates a new folder.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_sharefile_createfolder(void* lpObj, const char* lpszName, const char* lpszParentId);

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

Remarks

Creates a new folder and returns the new folder's itemId as a string. Must call ListItems or GetItemInfo before the Items properties will be updated with the new folder. Name is the name of the folder. ParentId is the id of the parent folder to the newly-created folder.

Note that the string root may be used as a folder Id to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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

Creates a new link for specified items.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR CreateLink(LPCWSTR lpszItemIds);

char* cloudstorage_sharefile_createlink(void* lpObj, const char* lpszItemIds);

QString CreateLink(const QString& qsItemIds);

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a ItemIds to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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.

CreatePermission Method (ShareFile Class)

Create a new Permissions for the specified folder and user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreatePermission(const char* lpszFolderId, const char* lpszUserId, int bRecursive);

Unicode (Windows)
INT CreatePermission(LPCWSTR lpszFolderId, LPCWSTR lpszUserId, BOOL bRecursive);

int cloudstorage_sharefile_createpermission(void* lpObj, const char* lpszFolderId, const char* lpszUserId, int bRecursive);

int CreatePermission(const QString& qsFolderId, const QString& qsUserId, bool bRecursive);

Remarks

Creates a new permission for a specified folder and user. The Permissions properties will not be updated with the new permission until the ListPermissions or GetPermissionInfo methods are called. FolderId is the id of the folder to add the permission to. UserId is the id of the user who will be getting the new permission. Recursive is to true when the user needs permission for all sub-folders within the specified folder. The CreatePermissionOptions property can be used to specify the different options for the newly created permission.

The CreatePermissionNotify and CreatePermissionNotifyMessage configurations can be used to notify the user at the email set in the ShareFilePermission type. string FolderId = shareFile.CreateFolder("test", "home"); string UserId = CreateUser("First", "Last", example@example.com, "company"); shareFile.Config("CreatePermissionNotify=True"); shareFile.Config("CreatePermissionNotifyMessage=CreatePermissionNotifyConfigTest"); shareFile.CreatePermission(FolderId, UserId, true);

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

CreateRequestLink Method (ShareFile Class)

Creates a new request link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateRequestLink(const char* lpszFolderId);

Unicode (Windows)
LPWSTR CreateRequestLink(LPCWSTR lpszFolderId);

char* cloudstorage_sharefile_createrequestlink(void* lpObj, const char* lpszFolderId);

QString CreateRequestLink(const QString& qsFolderId);

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process) with the new request link. It will also return the new request link as a string. FolderId is the ID for the directory where the files will be uploaded in ShareFile. The CreateLinkOptions property can be used to specify the different options for the newly created link.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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.

DeleteChildItems Method (ShareFile Class)

Removes multiple items from a parent item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteChildItems(const char* lpszParentId, const char* lpszItemIds);

Unicode (Windows)
INT DeleteChildItems(LPCWSTR lpszParentId, LPCWSTR lpszItemIds);

int cloudstorage_sharefile_deletechilditems(void* lpObj, const char* lpszParentId, const char* lpszItemIds);

int DeleteChildItems(const QString& qsParentId, const QString& qsItemIds);

Remarks

This method deletes multiple files or folders specified by ItemIds permanently. ParentId is the id of the parent item that contains the items that should be deleted. ItemIds is a comma separated list of ItemIds that are going to be deleted permanently. The items must be a child to the specified parent.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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

DeleteClient Method (ShareFile Class)

Deletes a client from the user list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteClient(const char* lpszUserId);

Unicode (Windows)
INT DeleteClient(LPCWSTR lpszUserId);

int cloudstorage_sharefile_deleteclient(void* lpObj, const char* lpszUserId);

int DeleteClient(const QString& qsUserId);

Remarks

Deletes a client from the user list. Must call ListUsers before the Users properties will be updated. UserId is the id for the user that is going to be deleted. // Deletes the first user. shareFile.ListUsers(); string UserId = shareFile.Users[0].Id; shareFile.DeleteClient(UserId);

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

DeleteItem Method (ShareFile Class)

Deletes an item permanently.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteItem(const char* lpszItemId);

Unicode (Windows)
INT DeleteItem(LPCWSTR lpszItemId);

int cloudstorage_sharefile_deleteitem(void* lpObj, const char* lpszItemId);

int DeleteItem(const QString& qsItemId);

Remarks

This method deletes the item specified by ItemId permanently. Must call ListItems before the Items properties property will be updated. // Deletes the first item. shareFile.ListItems(); string ItemId = shareFile.Items[0].Id; shareFile.DeleteItem(ItemId);

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

DeleteLink Method (ShareFile Class)

Deletes the link specified by the LinkId.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteLink(const char* lpszLinkId);

Unicode (Windows)
INT DeleteLink(LPCWSTR lpszLinkId);

int cloudstorage_sharefile_deletelink(void* lpObj, const char* lpszLinkId);

int DeleteLink(const QString& qsLinkId);

Remarks

Deletes the link specified by the LinkId permanently. The Links properties will not be updated until the ListLinks method is called. // Deletes the first link. shareFile.ListLinks(); string LinkId = shareFile.Link[0].Id; shareFile.DeleteLink(LinkId);

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

DeletePermission Method (ShareFile Class)

Removes a users permissions for a specific folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeletePermission(const char* lpszFolderId, const char* lpszUserId);

Unicode (Windows)
INT DeletePermission(LPCWSTR lpszFolderId, LPCWSTR lpszUserId);

int cloudstorage_sharefile_deletepermission(void* lpObj, const char* lpszFolderId, const char* lpszUserId);

int DeletePermission(const QString& qsFolderId, const QString& qsUserId);

Remarks

The method will remove a users permission for a specific folder. FolderId is the id of the folder that is having its permissions changed. UserId is the ID of the user that is getting permissions removed for the folder. Once the method is complete, the ListPermissions method must be called to update the Permissions properties. // Deletes the first permission. shareFile.ListPermissions(); string FolderId = shareFile.Link[0].FolderId; string UserId = shareFile.Link[0].UserId; shareFile.DeleteLink(FolderId, UserId);

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

This method downloads the file or the contents of the folder specified by the ItemId.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszItemId);

int cloudstorage_sharefile_downloadfile(void* lpObj, const char* lpszItemId);

int DownloadFile(const QString& qsItemId);

Remarks

The method will download the item specified by the ItemId. If a stream has been specified using SetDownloadStream, the file or folder data will be sent through it. If a stream is not specified, and LocalFile is set, the file or folder will be saved to the specified location. Otherwise, the class will use the data from the ItemData property; If the item is a directory, it will download the contents (recursively) of the directory as a ZIP file.

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

Name Conflict Resolution

If the Overwrite property is set to true, then the class will overwrite a file if one is found at the location specified by the LocalFile property. If it is set to false, then the class will throw an error if it finds a collision.

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

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

Simple Download

A simple download is consistent with setting the LocalFile to the destination of the file when it is downloaded and then calling the method with the item's id. For example: shareFile.LocalFile = "../MyFile.zip"; shareFile.DownloadFile(shareFile.Items[0].Id);

Streaming Download

To download to a stream, first call the SetDownloadStream method and then call the DownloadFile method. For example: shareFile.LocalFile = ""; using (FileStream fs = new FileStream("../../temp/temp_data1.zip", FileMode.OpenOrCreate)) { shareFile.SetDownloadStream(fs); shareFile.DownloadFile(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.)

GetItemInfo Method (ShareFile Class)

Gets information about a specific item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetItemInfo(const char* lpszItemId);

Unicode (Windows)
INT GetItemInfo(LPCWSTR lpszItemId);

int cloudstorage_sharefile_getiteminfo(void* lpObj, const char* lpszItemId);

int GetItemInfo(const QString& qsItemId);

Remarks

Calling this method will fire the ItemList event, and will populate the Items properties (clearing any previously-held items in the process)

ItemId is the id of the items that the class will get the information for. If the method is supplied a path (for ex. "/parentFolder/ChildFolder") then the class will use the path to get the item information.

Passing an ID string dirId = shareFile.CreateFolder("NewFolder", "home"); shareFile.GetItemInfo(dirId); Passing a path string dirId = shareFile.CreateFolder("NewFolder", "allshared"); shareFile.GetItemInfo("/NewFolder");

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

GetLinkInfo Method (ShareFile Class)

Gets information about a specific link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkInfo(const char* lpszLinkId);

Unicode (Windows)
INT GetLinkInfo(LPCWSTR lpszLinkId);

int cloudstorage_sharefile_getlinkinfo(void* lpObj, const char* lpszLinkId);

int GetLinkInfo(const QString& qsLinkId);

Remarks

Calling this method will fire the LinkList event, and will populate the Links properties (clearing any previously-held items in the process). LinkId is the id for the link that the class will get the information for. string linkId = shareFile.Links[0].Id; shareFile.GetLinkInfo(linkId);

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

GetPermissionInfo Method (ShareFile Class)

Gets information about a specific user's permission for a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPermissionInfo(const char* lpszFolderId, const char* lpszUserId);

Unicode (Windows)
INT GetPermissionInfo(LPCWSTR lpszFolderId, LPCWSTR lpszUserId);

int cloudstorage_sharefile_getpermissioninfo(void* lpObj, const char* lpszFolderId, const char* lpszUserId);

int GetPermissionInfo(const QString& qsFolderId, const QString& qsUserId);

Remarks

Calling this method will fire the PermissionList event, and will populate the Permissions properties (clearing any previously-held items in the process). FolderId is the item Id for the folder and UserId is the user Id for the user. string userId = shareFile.Users[0]; string folderId = shareFile.Items[0]; shareFile.GetPermissionInfo(folderId, userId);

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

GetUserInfo Method (ShareFile Class)

Gets information about a specific user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserInfo(const char* lpszUserId);

Unicode (Windows)
INT GetUserInfo(LPCWSTR lpszUserId);

int cloudstorage_sharefile_getuserinfo(void* lpObj, const char* lpszUserId);

int GetUserInfo(const QString& qsUserId);

Remarks

This method can accept the Id of a user, or the user's email through the UserId property. Calling this method will fire the UserList event once for the user, and will populate the Users properties (clearing any previously-held items in the process). string userId = shareFile.Users.Id; shareFile.getUserInfo(userId);

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

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ListItems Method (ShareFile Class)

Lists the files and folders within a folder.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ListItems(LPCWSTR lpszFolderId);

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

int ListItems(const QString& qsFolderId);

Remarks

The method takes a string FolderId which represents the ID of the folder that the class will list from. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

Note that the string root may be used as a FolderId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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

ListLinkItems Method (ShareFile Class)

Lists the files and folders of a link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListLinkItems(const char* lpszLinkId);

Unicode (Windows)
INT ListLinkItems(LPCWSTR lpszLinkId);

int cloudstorage_sharefile_listlinkitems(void* lpObj, const char* lpszLinkId);

int ListLinkItems(const QString& qsLinkId);

Remarks

Lists the items contained within the link. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

The items listed are not listed recursively. To get the items contained within folder items, further calls can be done using the ListItems method. string linkId = shareFile.Links[0].Id; shareFile.ListLinkItems(linkId);

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

ListLinks Method (ShareFile Class)

Lists the request/download links for the currently authenticated user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListLinks();

Unicode (Windows)
INT ListLinks();

int cloudstorage_sharefile_listlinks(void* lpObj);

int ListLinks();

Remarks

The method will list the request/download links for currently authenticated user. Calling this method will fire the LinkList event once for each link, and will also populate the Links properties.

Calling this method won't return the items of a link, but ListLinkItems can be used to get the items of the link.

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

ListPermissions Method (ShareFile Class)

Lists the permissions of a folder.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT ListPermissions(LPCWSTR lpszFolderId);

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

int ListPermissions(const QString& qsFolderId);

Remarks

The method will list the permissions of a folder defined by the FolderId parameter. Calling this method will fire the PermissionList event once for each permission, and will also populate the Permissions properties. string FolderId = shareFile.Items[0].Id; shareFile.ListPermissions(FolderId);

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

ListUsers Method (ShareFile Class)

Lists the client users of the authenticated account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListUsers();

Unicode (Windows)
INT ListUsers();

int cloudstorage_sharefile_listusers(void* lpObj);

int ListUsers();

Remarks

Calling this method will fire the UserList event once for each client user, and will also populate the Users properties.

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

MoveItem Method (ShareFile Class)

Moves an item to a different folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveItem(const char* lpszItemId, const char* lpszParentId, const char* lpszNewName);

Unicode (Windows)
INT MoveItem(LPCWSTR lpszItemId, LPCWSTR lpszParentId, LPCWSTR lpszNewName);

int cloudstorage_sharefile_moveitem(void* lpObj, const char* lpszItemId, const char* lpszParentId, const char* lpszNewName);

int MoveItem(const QString& qsItemId, const QString& qsParentId, const QString& qsNewName);

Remarks

This method will move the item, specified by the ItemId string, and moves it to a new folder, specified by the ParentId. NewName specifies the new name of the item; if empty, the item's original name is used.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

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

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

Search Method (ShareFile Class)

Searches for items 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_sharefile_search(void* lpObj, const char* lpszQuery);

int Search(const QString& qsQuery);

Remarks

This method searches for items that match the given Query parameter. Calling this method will fire the ItemList event once for each item, and will also populate the Items properties (clearing any previously-held items in the process).

As a note, this method makes a request to the simple search endpoint, rather than the advanced search endpoint.

shareFile.Search("Test.txt");

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

Sends a custom request to the ShareFile 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_sharefile_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 ShareFile API.

Valid values for HttpMethod are:

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

Usage

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the ShareFile API's stable endpoint, https://[SUBDOMAIN].sf-api.com/sf/v3.
   • 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, or the specified LocalFile (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 (ShareFile 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_sharefile_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 (ShareFile 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_sharefile_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.)

UpdateClient Method (ShareFile Class)

Updates a client's information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateClient(const char* lpszUserId, const char* lpszFirstName, const char* lpszLastName, const char* lpszEmail, const char* lpszCompany);

Unicode (Windows)
INT UpdateClient(LPCWSTR lpszUserId, LPCWSTR lpszFirstName, LPCWSTR lpszLastName, LPCWSTR lpszEmail, LPCWSTR lpszCompany);

int cloudstorage_sharefile_updateclient(void* lpObj, const char* lpszUserId, const char* lpszFirstName, const char* lpszLastName, const char* lpszEmail, const char* lpszCompany);

int UpdateClient(const QString& qsUserId, const QString& qsFirstName, const QString& qsLastName, const QString& qsEmail, const QString& qsCompany);

Remarks

Updates a clients first name, last name, email, and/or company. UserId represents the string Id for the client that will be updated. FirstName, LastName, Email, and Company each represents the update value for their corresponding ShareFileUser field.

Passing an empty string for FirstName, LastName, Email, or Company will mean that the field will not be updated. // Creates a client named FirstName Brown, with the email example@example.com with no company. string userId = shareFile.CreateClient("FirstName", "Brown", "example@example.com", ""); // Updates the First name of the client to John and sets a company, leave everything else the same. shareFile.UpdateClient(userId, "John", "", "", "nsoftware");

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

UpdateItemInfo Method (ShareFile Class)

Updates an item with new information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateItemInfo(const char* lpszItemId);

Unicode (Windows)
INT UpdateItemInfo(LPCWSTR lpszItemId);

int cloudstorage_sharefile_updateiteminfo(void* lpObj, const char* lpszItemId);

int UpdateItemInfo(const QString& qsItemId);

Remarks

This method updates the item information for an item identified by ItemId. The item should be in the Items properties and should be modified from there.

The following properties can be updated from the ShareFileItem type:

• Description
• ExpirationTime
• Name
• ParentId

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• home
• favorites
• allshared
• connectors
• box
• top.

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

UpdateLink Method (ShareFile Class)

Updates a request or download link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateLink(const char* lpszLinkId);

Unicode (Windows)
INT UpdateLink(LPCWSTR lpszLinkId);

int cloudstorage_sharefile_updatelink(void* lpObj, const char* lpszLinkId);

int UpdateLink(const QString& qsLinkId);

Remarks

This method updates the link information for a link identified by LinkId. The the class requires the link to be in the Links properties and be modified from there.

The following properties can be updated from the ShareFileLink type:

• ExpirationDate
• MaxDownloads
• Name
• RequireLogin
• Title

// Updates a link to require login. shareFile.Links[1].RequireLogin = true; shareFile.UpdateLink(shareFile.Links[1].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.)

UpdatePermission Method (ShareFile Class)

Updates the permission from the Permissions properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdatePermission(int iIndex, int bRecursive);

Unicode (Windows)
INT UpdatePermission(INT iIndex, BOOL bRecursive);

int cloudstorage_sharefile_updatepermission(void* lpObj, int iIndex, int bRecursive);

int UpdatePermission(int iIndex, bool bRecursive);

Remarks

The permission at Index in the Permissions properties will be updated.

The following properties can be updated from the ShareFilePermission type:

• CanDelete
• CanDownload
• CanManagePermissions
• CanUpload
• CanView
• NotifyOnDownload
• NotifyOnUpload

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

Will upload a file to a folder.

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_sharefile_uploadfile(void* lpObj, const char* lpszFileName, const char* lpszParentId);

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

Remarks

The method when called will upload a file specified in the LocalFile property. If SetUploadStream has been used to set an upload stream, it will take priority as the file data source. If LocalFile has not been set or a stream has not been set using SetUploadStream then the class will use the data found in the ItemData property; The file will be uploaded to the folder specified by the ParentId parameter. The name of the file will be what is passed to the FileName parameter. Once it has completed uploading it will return the id of the uploaded file.

Note that the string root may be used as a ParentId to represent the root folder, and the string home may be used as a folder Id to represent the home folder for the current user. Other special id's include:

• favorites
• allshared
• connectors
• box
• top

Name Conflict Resolution

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 ItemData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

ShareFile 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, 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. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to true. This is recommended for large files. 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. Once called and the class fragments the file, the ResumeURL property is populated. This URL needs to be set so that the class can resume the upload if the upload is interrupted.

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 and StartByte are populated (if the same instance of the class is used, they 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). 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. shareFile.UseResumableUpload = true; shareFile.LocalFile = "../MyFile.zip"; shareFile.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. shareFile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); shareFile.UseResumableUpload = true; shareFile.SetUploadStream(uploadStream); shareFile.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; shareFile.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 (ShareFile Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_ENDTRANSFER 1

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class ShareFileEndTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireEndTransfer(ShareFileEndTransferEventParams *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 (ShareFile Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_ERROR 2

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

class ShareFileErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireError(ShareFileErrorEventParams *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 (ShareFile Class)

Fires after each fragment of a resumable upload is completed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_FRAGMENTCOMPLETE 3

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

class ShareFileFragmentCompleteEventParams {
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(ShareFileFragmentCompleteEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireFragmentComplete(ShareFileFragmentCompleteEventParams *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 (ShareFile Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_HEADER 4

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

class ShareFileHeaderEventParams {
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(ShareFileHeaderEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireHeader(ShareFileHeaderEventParams *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).

ItemList Event (ShareFile Class)

This event fires once for each item returned when either ListItems , ListLinkItems or GetItemInfo is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireItemList(ShareFileItemListEventParams *e);

typedef struct {
  const char *Id;
  const char *Name;
  const char *Path;
  const char *CreatorFirstName;
  const char *CreatorLastName;
  int ItemType;
  const char *ParentId;
  const char *Description;
  const char *ExpirationDate;
  const char *CreationDate;
  int64 Size;
  int reserved;
} ShareFileItemListEventParams;


Unicode (Windows)
virtual INT FireItemList(ShareFileItemListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Name;
  LPCWSTR Path;
  LPCWSTR CreatorFirstName;
  LPCWSTR CreatorLastName;
  INT ItemType;
  LPCWSTR ParentId;
  LPCWSTR Description;
  LPCWSTR ExpirationDate;
  LPCWSTR CreationDate;
  LONG64 Size;
  INT reserved;
} ShareFileItemListEventParams;

#define EID_SHAREFILE_ITEMLIST 5

virtual INT CLOUDSTORAGE_CALL FireItemList(LPSTR &lpszId, LPSTR &lpszName, LPSTR &lpszPath, LPSTR &lpszCreatorFirstName, LPSTR &lpszCreatorLastName, INT &iItemType, LPSTR &lpszParentId, LPSTR &lpszDescription, LPSTR &lpszExpirationDate, LPSTR &lpszCreationDate, LONG64 &lSize);

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

  const QString &Name();

  const QString &Path();

  const QString &CreatorFirstName();

  const QString &CreatorLastName();

  int ItemType();

  const QString &ParentId();

  const QString &Description();

  const QString &ExpirationDate();

  const QString &CreationDate();

  qint64 Size();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireItemList(ShareFileItemListEventParams *e) {...}

Remarks

This event fires once for each item returned when either ListItems, ListLinkItems or GetItemInfo is called. The items cannot be modified from this event.

LinkList Event (ShareFile Class)

This event fires once for each link returned when ListLinks or GetLinkInfo is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLinkList(ShareFileLinkListEventParams *e);

typedef struct {
  const char *Id;
  const char *Title;
  const char *URL;
  int LinkType;
  int AccessLevel;
  const char *ExpirationDate;
  const char *CreationDate;
  int IsViewOnly;
  int MaxDownloads;
  int TotalDownloads;
  int NotifyOnAccess;
  int reserved;
} ShareFileLinkListEventParams;


Unicode (Windows)
virtual INT FireLinkList(ShareFileLinkListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Title;
  LPCWSTR URL;
  INT LinkType;
  INT AccessLevel;
  LPCWSTR ExpirationDate;
  LPCWSTR CreationDate;
  BOOL IsViewOnly;
  INT MaxDownloads;
  INT TotalDownloads;
  BOOL NotifyOnAccess;
  INT reserved;
} ShareFileLinkListEventParams;

#define EID_SHAREFILE_LINKLIST 6

virtual INT CLOUDSTORAGE_CALL FireLinkList(LPSTR &lpszId, LPSTR &lpszTitle, LPSTR &lpszURL, INT &iLinkType, INT &iAccessLevel, LPSTR &lpszExpirationDate, LPSTR &lpszCreationDate, BOOL &bIsViewOnly, INT &iMaxDownloads, INT &iTotalDownloads, BOOL &bNotifyOnAccess);

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

  const QString &Title();

  const QString &URL();

  int LinkType();

  int AccessLevel();

  const QString &ExpirationDate();

  const QString &CreationDate();

  bool IsViewOnly();

  int MaxDownloads();

  int TotalDownloads();

  bool NotifyOnAccess();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireLinkList(ShareFileLinkListEventParams *e) {...}

Remarks

This event fires once for each link returned when ListLinks or GetLinkInfo is called. The link cannot be modified from this event. This event will not show the items related to the specific link when calling ListLinkItems. Those will be listed using the ItemList event.

Log Event (ShareFile Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_LOG 7

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

class ShareFileLogEventParams {
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(ShareFileLogEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireLog(ShareFileLogEventParams *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"

PermissionList Event (ShareFile Class)

This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePermissionList(ShareFilePermissionListEventParams *e);

typedef struct {
  const char *FolderId;
  const char *UserId;
  int CanDelete;
  int CanDownload;
  int CanManagePermissions;
  int CanUpload;
  int CanView;
  int IsOwner;
  int NotifyOnDownload;
  int NotifyOnUpload;
  int reserved;
} ShareFilePermissionListEventParams;


Unicode (Windows)
virtual INT FirePermissionList(ShareFilePermissionListEventParams *e);

typedef struct {
  LPCWSTR FolderId;
  LPCWSTR UserId;
  BOOL CanDelete;
  BOOL CanDownload;
  BOOL CanManagePermissions;
  BOOL CanUpload;
  BOOL CanView;
  BOOL IsOwner;
  BOOL NotifyOnDownload;
  BOOL NotifyOnUpload;
  INT reserved;
} ShareFilePermissionListEventParams;

#define EID_SHAREFILE_PERMISSIONLIST 8

virtual INT CLOUDSTORAGE_CALL FirePermissionList(LPSTR &lpszFolderId, LPSTR &lpszUserId, BOOL &bCanDelete, BOOL &bCanDownload, BOOL &bCanManagePermissions, BOOL &bCanUpload, BOOL &bCanView, BOOL &bIsOwner, BOOL &bNotifyOnDownload, BOOL &bNotifyOnUpload);

class ShareFilePermissionListEventParams {
public:
  const QString &FolderId();

  const QString &UserId();

  bool CanDelete();

  bool CanDownload();

  bool CanManagePermissions();

  bool CanUpload();

  bool CanView();

  bool IsOwner();

  bool NotifyOnDownload();

  bool NotifyOnUpload();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FirePermissionList(ShareFilePermissionListEventParams *e) {...}

Remarks

This event fires once for each permission returned when ListPermissions or GetPermissionInfo is called. The permissions cannot be modified from this event. The FolderId represents the item Id for the specific folder the permission is for. The UserId represents the Id for the user the permission is for.

Progress Event (ShareFile Class)

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_PROGRESS 9

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

class ShareFileProgressEventParams {
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(ShareFileProgressEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireProgress(ShareFileProgressEventParams *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.

SSLServerAuthentication Event (ShareFile Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_SSLSERVERAUTHENTICATION 10

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

class ShareFileSSLServerAuthenticationEventParams {
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(ShareFileSSLServerAuthenticationEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireSSLServerAuthentication(ShareFileSSLServerAuthenticationEventParams *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 (ShareFile Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_SSLSTATUS 11

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (ShareFile Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_STARTTRANSFER 12

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class ShareFileStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireStartTransfer(ShareFileStartTransferEventParams *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 (ShareFile Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SHAREFILE_TRANSFER 13

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

class ShareFileTransferEventParams {
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(ShareFileTransferEventParams *e);

// Or, subclass ShareFile and override this emitter function.
virtual int FireTransfer(ShareFileTransferEventParams *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.

UserList Event (ShareFile Class)

This event fires once for each user returned when ListUsers or GetUserInfo is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireUserList(ShareFileUserListEventParams *e);

typedef struct {
  const char *Id;
  const char *FirstName;
  const char *LastName;
  const char *Company;
  const char *Email;
  const char *CreationDate;
  int reserved;
} ShareFileUserListEventParams;


Unicode (Windows)
virtual INT FireUserList(ShareFileUserListEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR FirstName;
  LPCWSTR LastName;
  LPCWSTR Company;
  LPCWSTR Email;
  LPCWSTR CreationDate;
  INT reserved;
} ShareFileUserListEventParams;

#define EID_SHAREFILE_USERLIST 14

virtual INT CLOUDSTORAGE_CALL FireUserList(LPSTR &lpszId, LPSTR &lpszFirstName, LPSTR &lpszLastName, LPSTR &lpszCompany, LPSTR &lpszEmail, LPSTR &lpszCreationDate);

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

  const QString &FirstName();

  const QString &LastName();

  const QString &Company();

  const QString &Email();

  const QString &CreationDate();

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

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

// Or, subclass ShareFile and override this emitter function.
virtual int FireUserList(ShareFileUserListEventParams *e) {...}

Remarks

This event fires once for each user returned when ListUsers or GetUserInfo is called. The users cannot be modified from this event. If the user does not have a specified company that parameter will be left as an empty string ("").

Certificate Type

This is the digital certificate being used.

Syntax

CloudStorageCertificate (declared in cloudstorage.h)

Remarks

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

Fields