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

cloudstorage.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 collection 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 collection. For links the collection is the Links collection and for users it is the Users collection.

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

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

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

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

public String getAccountSubdomain();
public void setAccountSubdomain(String accountSubdomain);

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.

Authorization Property (ShareFile Class)

OAuth 2.0 Authorization Token.

Syntax

public String getAuthorization();
public void setAuthorization(String authorization);

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

CreateLinkOptions Property (ShareFile Class)

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

Syntax

public ShareFileLink getCreateLinkOptions();
public void setCreateLinkOptions(ShareFileLink createLinkOptions);

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.

CreatePermissionOptions Property (ShareFile Class)

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

Syntax

public ShareFilePermission getCreatePermissionOptions();
public void setCreatePermissionOptions(ShareFilePermission createPermissionOptions);

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.

EncryptionAlgorithm Property (ShareFile Class)

The encryption algorithm.

Syntax

public int getEncryptionAlgorithm();
public void setEncryptionAlgorithm(int encryptionAlgorithm);

Enumerated values:
  public final static int eaAES = 0;
  public final static int eaBlowfish = 1;
  public final static int eaCAST = 2;
  public final static int eaDES = 3;
  public final static int eaIDEA = 4;
  public final static int eaRC2 = 5;
  public final static int eaRC4 = 6;
  public final static int eaTEA = 7;
  public final static int eaTripleDES = 8;
  public final static int eaTwofish = 9;
  public final static int eaRijndael = 10;
  public final static int eaChaCha = 11;
  public final static int eaXSalsa20 = 12;

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:

EncryptionPassword Property (ShareFile Class)

The encryption password.

Syntax

public String getEncryptionPassword();
public void setEncryptionPassword(String encryptionPassword);

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.

Firewall Property (ShareFile Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

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

Idle Property (ShareFile Class)

The current status of the class.

Syntax

public boolean isIdle();

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.

ItemData Property (ShareFile Class)

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

Syntax

public byte[] getItemData();
public void setItemData(byte[] itemData);

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.

Items Property (ShareFile Class)

A properties of items.

Syntax

public ShareFileItemList getItems();
public void setItems(ShareFileItemList items);

Remarks

This collection holds a list of file and folder items.

Calling ListItems , ListLinkItems or GetItemInfo will populate this collection.

This property is not available at design time.

Links Property (ShareFile Class)

A properties of links.

Syntax

public ShareFileLinkList getLinks();
public void setLinks(ShareFileLinkList links);

Remarks

This collection holds a list of links.

Calling ListLinks or GetLinkInfo will populate this collection.

This property is not available at design time.

LocalFile Property (ShareFile Class)

The location of the local file.

Syntax

public String getLocalFile();
public void setLocalFile(String localFile);

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.

LocalHost Property (ShareFile Class)

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

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

""

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the 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.

OAuth Property (ShareFile Class)

This property holds the OAuth Settings.

Syntax

public OAuthSettings getOAuth();

Remarks

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

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

OtherHeaders Property (ShareFile Class)

Other headers as determined by the user (optional).

Syntax

public String getOtherHeaders();
public void setOtherHeaders(String otherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\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.

Overwrite Property (ShareFile Class)

Whether to overwrite the local or remote file.

Syntax

public boolean isOverwrite();
public void setOverwrite(boolean overwrite);

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.

ParsedHeaders Property (ShareFile Class)

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

Syntax

public HeaderList getParsedHeaders();

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 collection is indexed from 0 to size -1.

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

Permissions Property (ShareFile Class)

A properties of permissions.

Syntax

public ShareFilePermissionList getPermissions();
public void setPermissions(ShareFilePermissionList permissions);

Remarks

This collection holds a list of permissions.

Calling ListPermissions or GetPermissionInfo will populate this collection.

This property is not available at design time.

Proxy Property (ShareFile Class)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();
public void setProxy(Proxy proxy);

Remarks

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

QueryParams Property (ShareFile Class)

Additional query parameters to be included in the request.

Syntax

public QueryParamList getQueryParams();
public void setQueryParams(QueryParamList queryParams);

Remarks

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

ResumeURL Property (ShareFile Class)

The resumable upload URL.

Syntax

public String getResumeURL();
public void setResumeURL(String resumeURL);

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.

SearchMarker Property (ShareFile Class)

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

Syntax

public int getSearchMarker();
public void setSearchMarker(int searchMarker);

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.

SSLAcceptServerCert Property (ShareFile Class)

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

Syntax

public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

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.

SSLCert Property (ShareFile Class)

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

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

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.

SSLProvider Property (ShareFile Class)

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

Syntax

public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

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, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

SSLServerCert Property (ShareFile Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StartByte Property (ShareFile Class)

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

Syntax

public long getStartByte();
public void setStartByte(long startByte);

Default Value

0

Remarks

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

When uploading from a stream, the 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.

Timeout Property (ShareFile Class)

The timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

60

Remarks

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

If Timeout is set to a positive value, the 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 throws an exception.

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

The default value for the Timeout property is 60 seconds.

UseResumableUpload Property (ShareFile Class)

Whether to use resumable uploads.

Syntax

public boolean isUseResumableUpload();
public void setUseResumableUpload(boolean useResumableUpload);

Default Value

False

Remarks

This property controls whether simple or resumable uploads are used when UploadFile is called. The default value is false (simple uploads are used).

Refer to UploadFile for more information.

This property is not available at design time.

Users Property (ShareFile Class)

A properties of users.

Syntax

public ShareFileUserList getUsers();
public void setUsers(ShareFileUserList users);

Remarks

This collection holds a list of users.

Calling ListUsers or GetUserInfo will populate this collection.

This property is not available at design time.

AddQueryParam Method (ShareFile Class)

Adds a query parameter to the QueryParams properties.

Syntax

public void addQueryParam(String name, String value);

Remarks

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

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

Authorize Method (ShareFile Class)

Get the authorization string required to access the protected resource.

Syntax

public void 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.

CalcAuthorization Method (ShareFile Class)

Calculates the Authorization header based on provided credentials.

Syntax

public void 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.

Config Method (ShareFile Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyItem Method (ShareFile Class)

Copies the specified item into the specified directory.

Syntax

public String copyItem(String itemId, String parentId);

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 collection 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

CreateAndEmailLink Method (ShareFile Class)

Creates a link for specified items and emails it.

Syntax

public String createAndEmailLink(String itemIds, String emails, String subject, String note);

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links collection (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

CreateAndEmailRequestLink Method (ShareFile Class)

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

Syntax

public String createAndEmailRequestLink(String folderId, String emails, String subject, String note);

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links collection (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

CreateClient Method (ShareFile Class)

Creates a new client.

Syntax

public String createClient(String firstName, String lastName, String email, String company);

Remarks

Creates a new client user and returns the new client id as a string. The Users collection 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", "");

CreateFolder Method (ShareFile Class)

Creates a new folder.

Syntax

public String createFolder(String name, String parentId);

Remarks

Creates a new folder and returns the new folder's itemId as a string. Must call ListItems or GetItemInfo before the Items collection 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

CreateLink Method (ShareFile Class)

Creates a new link for specified items.

Syntax

public String createLink(String itemIds);

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Links collection (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

CreatePermission Method (ShareFile Class)

Create a new Permissions for the specified folder and user.

Syntax

public void createPermission(String folderId, String userId, boolean recursive);

Remarks

Creates a new permission for a specified folder and user. The Permissions collection 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);

CreateRequestLink Method (ShareFile Class)

Creates a new request link.

Syntax

public String createRequestLink(String folderId);

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Links collection (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

DeleteChildItems Method (ShareFile Class)

Removes multiple items from a parent item.

Syntax

public void deleteChildItems(String parentId, String itemIds);

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

DeleteClient Method (ShareFile Class)

Deletes a client from the user list.

Syntax

public void deleteClient(String userId);

Remarks

Deletes a client from the user list. Must call ListUsers before the Users collection 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);

DeleteItem Method (ShareFile Class)

Deletes an item permanently.

Syntax

public void deleteItem(String itemId);

Remarks

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

DeleteLink Method (ShareFile Class)

Deletes the link specified by the LinkId.

Syntax

public void deleteLink(String linkId);

Remarks

Deletes the link specified by the LinkId permanently. The Links collection 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);

DeletePermission Method (ShareFile Class)

Removes a users permissions for a specific folder.

Syntax

public void deletePermission(String folderId, String userId);

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 collection. // Deletes the first permission. shareFile.ListPermissions(); string FolderId = shareFile.Link[0].FolderId; string UserId = shareFile.Link[0].UserId; shareFile.DeleteLink(FolderId, UserId);

DownloadFile Method (ShareFile Class)

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

Syntax

public void downloadFile(String itemId);

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

GetItemInfo Method (ShareFile Class)

Gets information about a specific item.

Syntax

public void getItemInfo(String itemId);

Remarks

Calling this method will fire the ItemList event, and will populate the Items collection (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");

GetLinkInfo Method (ShareFile Class)

Gets information about a specific link.

Syntax

public void getLinkInfo(String linkId);

Remarks

Calling this method will fire the LinkList event, and will populate the Links collection (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);

GetPermissionInfo Method (ShareFile Class)

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

Syntax

public void getPermissionInfo(String folderId, String userId);

Remarks

Calling this method will fire the PermissionList event, and will populate the Permissions collection (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);

GetUserInfo Method (ShareFile Class)

Gets information about a specific user.

Syntax

public void getUserInfo(String userId);

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 collection (clearing any previously-held items in the process). string userId = shareFile.Users.Id; shareFile.getUserInfo(userId);

Interrupt Method (ShareFile Class)

This method interrupts the current method.

Syntax

public void interrupt();

Remarks

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

ListItems Method (ShareFile Class)

Lists the files and folders within a folder.

Syntax

public void listItems(String folderId);

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 collection (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

ListLinkItems Method (ShareFile Class)

Lists the files and folders of a link.

Syntax

public void listLinkItems(String linkId);

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

ListLinks Method (ShareFile Class)

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

Syntax

public void 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 collection.

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

ListPermissions Method (ShareFile Class)

Lists the permissions of a folder.

Syntax

public void listPermissions(String folderId);

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 collection. string FolderId = shareFile.Items[0].Id; shareFile.ListPermissions(FolderId);

ListUsers Method (ShareFile Class)

Lists the client users of the authenticated account.

Syntax

public void listUsers();

Remarks

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

MoveItem Method (ShareFile Class)

Moves an item to a different folder.

Syntax

public void moveItem(String itemId, String parentId, String newName);

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

Reset Method (ShareFile Class)

Resets the class to its initial state.

Syntax

public void reset();

Remarks

This method resets the class to its initial state.

Search Method (ShareFile Class)

Searches for items that match the specified query.

Syntax

public void search(String query);

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 collection (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");

SendCustomRequest Method (ShareFile Class)

Sends a custom request to the ShareFile API.

Syntax

public void sendCustomRequest(String httpMethod, String requestPath, String requestBody);

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 collection 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 collection, 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.

SetDownloadStream Method (ShareFile Class)

Sets the stream to which downloaded data will be written.

Syntax

public void setDownloadStream(java.io.OutputStream downloadStream);

Remarks

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

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

SetUploadStream Method (ShareFile Class)

Sets the stream from which data is read when uploading.

Syntax

public void setUploadStream(java.io.InputStream uploadStream);

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.

UpdateClient Method (ShareFile Class)

Updates a client's information.

Syntax

public void updateClient(String userId, String firstName, String lastName, String email, String company);

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

UpdateItemInfo Method (ShareFile Class)

Updates an item with new information.

Syntax

public void updateItemInfo(String itemId);

Remarks

This method updates the item information for an item identified by ItemId. The item should be in the Items collection 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.

UpdateLink Method (ShareFile Class)

Updates a request or download link.

Syntax

public void updateLink(String linkId);

Remarks

This method updates the link information for a link identified by LinkId. The the class requires the link to be in the Links collection 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);

UpdatePermission Method (ShareFile Class)

Updates the permission from the Permissions properties.

Syntax

public void updatePermission(int index, boolean recursive);

Remarks

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

The following properties can be updated from the ShareFilePermission type:

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

UploadFile Method (ShareFile Class)

Will upload a file to a folder.

Syntax

public String uploadFile(String fileName, String parentId);

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

EndTransfer Event (ShareFile Class)

This event fires when a document finishes transferring.

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void endTransfer(ShareFileEndTransferEvent e) {}
  ...
}

public class ShareFileEndTransferEvent {
  public int direction;
}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (ShareFile Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void error(ShareFileErrorEvent e) {}
  ...
}

public class ShareFileErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (ShareFile Class)

Fires after each fragment of a resumable upload is completed.

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void fragmentComplete(ShareFileFragmentCompleteEvent e) {}
  ...
}

public class ShareFileFragmentCompleteEvent {
  public int fragmentNumber;
  public int fragmentCount;
  public boolean interrupt; //read-write
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void header(ShareFileHeaderEvent e) {}
  ...
}

public class ShareFileHeaderEvent {
  public String field;
  public String value;
}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

ItemList Event (ShareFile Class)

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

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void itemList(ShareFileItemListEvent e) {}
  ...
}

public class ShareFileItemListEvent {
  public String id;
  public String name;
  public String path;
  public String creatorFirstName;
  public String creatorLastName;
  public int itemType;
  public String parentId;
  public String description;
  public String expirationDate;
  public String creationDate;
  public long size;
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void linkList(ShareFileLinkListEvent e) {}
  ...
}

public class ShareFileLinkListEvent {
  public String id;
  public String title;
  public String URL;
  public int linkType;
  public int accessLevel;
  public String expirationDate;
  public String creationDate;
  public boolean isViewOnly;
  public int maxDownloads;
  public int totalDownloads;
  public boolean notifyOnAccess;
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void log(ShareFileLogEvent e) {}
  ...
}

public class ShareFileLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void permissionList(ShareFilePermissionListEvent e) {}
  ...
}

public class ShareFilePermissionListEvent {
  public String folderId;
  public String userId;
  public boolean canDelete;
  public boolean canDownload;
  public boolean canManagePermissions;
  public boolean canUpload;
  public boolean canView;
  public boolean isOwner;
  public boolean notifyOnDownload;
  public boolean notifyOnUpload;
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void progress(ShareFileProgressEvent e) {}
  ...
}

public class ShareFileProgressEvent {
  public int direction;
  public long bytesTransferred;
  public long totalBytes;
  public int percentDone;
}

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (ShareFile Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void SSLServerAuthentication(ShareFileSSLServerAuthenticationEvent e) {}
  ...
}

public class ShareFileSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void SSLStatus(ShareFileSSLStatusEvent e) {}
  ...
}

public class ShareFileSSLStatusEvent {
  public String message;
}

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

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void startTransfer(ShareFileStartTransferEvent e) {}
  ...
}

public class ShareFileStartTransferEvent {
  public int direction;
}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (ShareFile Class)

Fired while a document transfers (delivers document).

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void transfer(ShareFileTransferEvent e) {}
  ...
}

public class ShareFileTransferEvent {
  public int direction;
  public long bytesTransferred;
  public int percentDone;
  public byte[] text;
}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

UserList Event (ShareFile Class)

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

Syntax

public class DefaultShareFileEventListener implements ShareFileEventListener {
  ...
  public void userList(ShareFileUserListEvent e) {}
  ...
}

public class ShareFileUserListEvent {
  public String id;
  public String firstName;
  public String lastName;
  public String company;
  public String email;
  public String creationDate;
}

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.

Remarks

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

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

Firewall Type

The firewall the class will connect through.

Remarks

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

Fields

Constructors

public Firewall();

Header Type

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

Remarks

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

Fields

Constructors

public Header();

public Header( field,  value);

OAuthSettings Type

The settings to use to authenticate with the service provider.

Remarks

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

Fields

Constructors

public OAuthSettings();

Proxy Type

The proxy the class will connect to.

Remarks

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

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

QueryParam Type

A query parameter to send in the request.

Remarks

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

Fields

Constructors

public QueryParam();

public QueryParam( name,  value);

ShareFileItem Type

A ShareFile Item.

Remarks

Represents an Item retrieved from ShareFile. Typically, the class deals with folder and file items types.

Fields

Constructors

public ShareFileItem();

ShareFileLink Type

A ShareFile share link.

Remarks

Represents a share link retrieved from ShareFile.

Fields

Constructors

public ShareFileLink();

ShareFilePermission Type

ShareFile permission type.

Remarks

Represents a ShareFile permission. Permissions are folder specific and are not on a per item/file basis.

Fields

Constructors

public ShareFilePermission();

ShareFileUser Type

A ShareFile user.

Remarks

Represents a ShareFile user.

Fields

Constructors

public ShareFileUser();

Config Settings (ShareFile Class)

ShareFile Config Settings

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

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

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (ShareFile Class)

Common Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors