IPWorks Cloud 2020 C++ Builder Edition

Questions / Feedback?

ShareFile Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

TicsShareFile

Remarks

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

This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

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

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 component 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 component also clears and populates the Links* properties with the new link. When creating a link, you can use the CreateLinkOptions* properties to set certain options for the link.

When a permission is created using the CreatePermission method, the component 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* properties 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 component can also list out the items associated with a specified link. The ListLinkItems method will take a LinkId and populate Items* properties.

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

Uploading Files

The UploadFile method uploads new file items.

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 component 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 component will automatically fragment the specified file into smaller pieces and upload each individually.

When UseResumableUpload is set to true and UploadFile is called, a resumable upload session is started by the component. Once called and the component fragments the file, the ResumeURL property is populated. This URL needs to be set so that the component 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 component also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that ResumeURL and StartByte are populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). 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");

Additional Functionality

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

Property List


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

AccountSubdomainRepresent a ShareFile domain for the account.
AuthorizationOAuth 2.0 Authorization Token.
CreateLinkOptionsAccessLevelThe access level for the link.
CreateLinkOptionsCreationDateThe date the link was created.
CreateLinkOptionsExpirationDateThe expiration date for the link.
CreateLinkOptionsIdThe id of the link.
CreateLinkOptionsIsViewOnlyIf the share items can only be viewed.
CreateLinkOptionsMaxDownloadsThe maximum downloads for a link.
CreateLinkOptionsNotifyOnAccessIf the creator is notified when a user accesses the link.
CreateLinkOptionsTitleThe title of the link.
CreateLinkOptionsTotalDownloadsTotal number of times the link has been downloaded from.
CreateLinkOptionsTypeThe link's type.
CreateLinkOptionsURLThe url for the link.
CreatePermissionOptionsCanDeleteIf the user can delete the item or from the item.
CreatePermissionOptionsCanDownloadIf the user can read file content or download the item or from the item.
CreatePermissionOptionsCanManagePermissionsIf the user can configure Access Controls in the item.
CreatePermissionOptionsCanUploadWhether the user can upload files to the item.
CreatePermissionOptionsCanViewIf the user can view items from the item.
CreatePermissionOptionsFolderIdThe item id for the folder whose permissions are being defined.
CreatePermissionOptionsIsOwnerIf the user is the owner.
CreatePermissionOptionsNotifyOnDownloadIf the user is notified when the an item is downloaded from the folder.
CreatePermissionOptionsNotifyOnUploadIf the user is notified when the an item is uploaded to the folder.
CreatePermissionOptionsUserIdThe user's ShareFile id.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
ItemDataThe data that was downloaded, or that should be uploaded by the component.
ItemCountThe number of records in the Item arrays.
ItemCreationDateThe date when the item was created.
ItemCreatorFirstNameThe first name of the creator.
ItemCreatorLastNameThe last name of the creator.
ItemDescriptionThe description of the item.
ItemExpirationDateThe expiration date for the item.
ItemIdThe id of the item.
ItemNameThe name of the item.
ItemParentIdThe id of the parent item.
ItemPathThe path to the parent folder for an item.
ItemSizeThe size of the item.
ItemTypeThe item's type.
LinkCountThe number of records in the Link arrays.
LinkAccessLevelThe access level for the link.
LinkCreationDateThe date the link was created.
LinkExpirationDateThe expiration date for the link.
LinkIdThe id of the link.
LinkIsViewOnlyIf the share items can only be viewed.
LinkMaxDownloadsThe maximum downloads for a link.
LinkNotifyOnAccessIf the creator is notified when a user accesses the link.
LinkTitleThe title of the link.
LinkTotalDownloadsTotal number of times the link has been downloaded from.
LinkTypeThe link's type.
LinkURLThe url for the link.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether to overwrite the local or remote file.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PermissionCountThe number of records in the Permission arrays.
PermissionCanDeleteIf the user can delete the item or from the item.
PermissionCanDownloadIf the user can read file content or download the item or from the item.
PermissionCanManagePermissionsIf the user can configure Access Controls in the item.
PermissionCanUploadWhether the user can upload files to the item.
PermissionCanViewIf the user can view items from the item.
PermissionFolderIdThe item id for the folder whose permissions are being defined.
PermissionIsOwnerIf the user is the owner.
PermissionNotifyOnDownloadIf the user is notified when the an item is downloaded from the folder.
PermissionNotifyOnUploadIf the user is notified when the an item is uploaded to the folder.
PermissionUserIdThe user's ShareFile id.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueryParamCountThe number of records in the QueryParam arrays.
QueryParamNameThe name of the query parameter.
QueryParamValueThe value of the query parameter.
ResumeURLThe resumable upload URL.
SearchMarkerA marker indicating the number of search results to skip next.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the component.
UseResumableUploadWhether to use resumable uploads.
UserCountThe number of records in the User arrays.
UserCompanyThe company of the user.
UserCreationDateThe date the user was created.
UserEmailThe email address of the user.
UserFirstNameThe first name of the user.
UserIdThe id of the user.
UserLastNameThe last name of the user.

Method List


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

AddQueryParamAdds a query parameter to the QueryParams properties.
ConfigSets or retrieves a configuration setting.
CopyItemCopies the specified item into the specified directory.
CreateAndEmailLinkCreates a link for specified items and emails it.
CreateAndEmailRequestLinkCreates a new request link and emails it to the specified emails.
CreateClientCreates a new client.
CreateFolderCreates a new folder.
CreateLinkCreates a new link for specified items.
CreatePermissionCreate a new Permissions for the specified folder and user.
CreateRequestLinkCreates a new request link.
DeleteChildItemsRemoves multiple items from a parent item.
DeleteClientDeletes a client from the user list.
DeleteItemDeletes an item permanently.
DeleteLinkDeletes the link specified by the LinkId.
DeletePermissionRemoves a users permissions for a specific folder.
DownloadFileThis method downloads the file or the contents of the folder specified by the ItemId.
GetItemInfoGets information about a specific item.
GetLinkInfoGets information about a specific link.
GetPermissionInfoGets information about a specific user's permission for a folder.
GetUserInfoGets information about a specific user.
InterruptInterrupt the current method.
ListItemsLists the files and folders within a folder.
ListLinkItemsLists the files and folders of a link.
ListLinksLists the request/download links for the currently authenticated user.
ListPermissionsLists the permissions of a folder.
ListUsersLists the client users of the authenticated account.
MoveItemMoves an item to a different folder.
ResetResets the component to its initial state.
SearchReserved for future use.
SendCustomRequestSends a custom request to the ShareFile API.
UpdateClientUpdates a client's information.
UpdateItemInfoUpdates an item with new information.
UpdateLinkUpdates a request or download link.
UpdatePermissionUpdates the permission from the Permission* properties.
UploadFileWill upload a file to a folder.

Event List


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

EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteFires after each fragment of a resumable upload is completed.
HeaderFired every time a header line comes in.
ItemListThis event fires once for each item returned when either ListItems , ListLinkItems or GetItemInfo is called.
LinkListThis event fires once for each link returned when ListLinks or GetLinkInfo is called.
LogFires once for each log message.
PermissionListThis event fires once for each permission returned when ListPermissions or GetPermissionInfo is called.
ProgressFires during an upload or download to indicate transfer progress.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).
UserListThis event fires once for each user returned when ListUsers or GetUserInfo is called.

Configuration Settings


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

AccumulatePagesWhether the component should accumulate subsequent pages of results when listing them.
CreatePermissionNotifyWhether to notify users of the permission they granted.
CreatePermissionNotifyMessageThe custom notify message used in permission notification email.
DeleteChildItemsPermanentlyWhether ChildItems should be deleted permanently.
DeleteUserCompletelyWhether to delete user completely.
ForceSyncWhether ShareFile will block the operation from taking place asynchronously.
IncludeDeletedItemsWhether deleted items should be include in the results.
IncludeExpiredLinksWhether expired links should be include in the results.
ListUsersTypeThe type used to list users.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
SearchPageSizeLimits the number of search results.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 C++ Builder Edition - Version 20.0 [Build 8265]