ShareFile Module

Properties   Methods   Events   Config Settings   Errors  

The ShareFile module 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken property 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType property. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the OAuthGrantType property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode property, 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 OAuthRefreshToken property 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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 OAuthGrantType the class requires OAuthPasswordGrantUsername, OAuthClientSecret, and OAuthServerTokenURL to be set. The OAuthClientSecret should be set to the password of the account instead of a typical secret. In some cases, the OAuthClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

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

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

Referencing and Creating Items, Links, Permissions, and Users

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

When a link is created using methods like CreateAndEmailLink , CreateAndEmailRequestLink, CreateLink, or CreateRequestLink then their URL is returned rather than their ShareFile id. To get the newly created id, the class also clears and populates the Links* properties with the new link. When creating a link, you can use the CreateLinkOptions* properties 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* 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 class can also list out the items associated with a specified link. The ListLinkItems method will take a LinkId and populate Items* properties.

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

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

Downloading Files

The DownloadFile method downloads file or folder items.

If 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 class uses the simple upload mechanism. ShareFile.LocalFile = "../MyFile.zip"; ShareFile.UploadFile("/MyFile.zip");

Resumable

To enable resumable uploads set UseResumableUpload to . 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 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). 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 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccountSubdomain Property (ShareFile Module)

Represent a ShareFile domain for the account.

Syntax

• Swift
• Objective-C

public var accountSubdomain: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=accountSubdomain,setter=setAccountSubdomain:) NSString* accountSubdomain;

- (NSString*)accountSubdomain;
- (void)setAccountSubdomain :(NSString*)newAccountSubdomain;

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

OAuth 2.0 Authorization Token.

Syntax

• Swift
• Objective-C

public var authorization: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=authorization,setter=setAuthorization:) NSString* authorization;

- (NSString*)authorization;
- (void)setAuthorization :(NSString*)newAuthorization;

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN

CreateLinkOptions Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var createLinkOptions: ShareFileLink {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=createLinkOptionsAccessLevel,setter=setCreateLinkOptionsAccessLevel:) int createLinkOptionsAccessLevel;

- (int)createLinkOptionsAccessLevel;
- (void)setCreateLinkOptionsAccessLevel :(int)newCreateLinkOptionsAccessLevel;

@property (nonatomic,readonly,assign,getter=createLinkOptionsCreationDate) NSString* createLinkOptionsCreationDate;

- (NSString*)createLinkOptionsCreationDate;

@property (nonatomic,readwrite,assign,getter=createLinkOptionsExpirationDate,setter=setCreateLinkOptionsExpirationDate:) NSString* createLinkOptionsExpirationDate;

- (NSString*)createLinkOptionsExpirationDate;
- (void)setCreateLinkOptionsExpirationDate :(NSString*)newCreateLinkOptionsExpirationDate;

@property (nonatomic,readonly,assign,getter=createLinkOptionsId) NSString* createLinkOptionsId;

- (NSString*)createLinkOptionsId;

@property (nonatomic,readwrite,assign,getter=createLinkOptionsIsViewOnly,setter=setCreateLinkOptionsIsViewOnly:) BOOL createLinkOptionsIsViewOnly;

- (BOOL)createLinkOptionsIsViewOnly;
- (void)setCreateLinkOptionsIsViewOnly :(BOOL)newCreateLinkOptionsIsViewOnly;

@property (nonatomic,readwrite,assign,getter=createLinkOptionsMaxDownloads,setter=setCreateLinkOptionsMaxDownloads:) int createLinkOptionsMaxDownloads;

- (int)createLinkOptionsMaxDownloads;
- (void)setCreateLinkOptionsMaxDownloads :(int)newCreateLinkOptionsMaxDownloads;

@property (nonatomic,readwrite,assign,getter=createLinkOptionsNotifyOnAccess,setter=setCreateLinkOptionsNotifyOnAccess:) BOOL createLinkOptionsNotifyOnAccess;

- (BOOL)createLinkOptionsNotifyOnAccess;
- (void)setCreateLinkOptionsNotifyOnAccess :(BOOL)newCreateLinkOptionsNotifyOnAccess;

@property (nonatomic,readwrite,assign,getter=createLinkOptionsTitle,setter=setCreateLinkOptionsTitle:) NSString* createLinkOptionsTitle;

- (NSString*)createLinkOptionsTitle;
- (void)setCreateLinkOptionsTitle :(NSString*)newCreateLinkOptionsTitle;

@property (nonatomic,readonly,assign,getter=createLinkOptionsTotalDownloads) int createLinkOptionsTotalDownloads;

- (int)createLinkOptionsTotalDownloads;

@property (nonatomic,readonly,assign,getter=createLinkOptionsType) int createLinkOptionsType;

- (int)createLinkOptionsType;

@property (nonatomic,readonly,assign,getter=createLinkOptionsURL) NSString* createLinkOptionsURL;

- (NSString*)createLinkOptionsURL;

 

Default Value

""

Remarks

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

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

CreatePermissionOptions Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var createPermissionOptions: ShareFilePermission {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsCanDelete,setter=setCreatePermissionOptionsCanDelete:) BOOL createPermissionOptionsCanDelete;

- (BOOL)createPermissionOptionsCanDelete;
- (void)setCreatePermissionOptionsCanDelete :(BOOL)newCreatePermissionOptionsCanDelete;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsCanDownload,setter=setCreatePermissionOptionsCanDownload:) BOOL createPermissionOptionsCanDownload;

- (BOOL)createPermissionOptionsCanDownload;
- (void)setCreatePermissionOptionsCanDownload :(BOOL)newCreatePermissionOptionsCanDownload;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsCanManagePermissions,setter=setCreatePermissionOptionsCanManagePermissions:) BOOL createPermissionOptionsCanManagePermissions;

- (BOOL)createPermissionOptionsCanManagePermissions;
- (void)setCreatePermissionOptionsCanManagePermissions :(BOOL)newCreatePermissionOptionsCanManagePermissions;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsCanUpload,setter=setCreatePermissionOptionsCanUpload:) BOOL createPermissionOptionsCanUpload;

- (BOOL)createPermissionOptionsCanUpload;
- (void)setCreatePermissionOptionsCanUpload :(BOOL)newCreatePermissionOptionsCanUpload;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsCanView,setter=setCreatePermissionOptionsCanView:) BOOL createPermissionOptionsCanView;

- (BOOL)createPermissionOptionsCanView;
- (void)setCreatePermissionOptionsCanView :(BOOL)newCreatePermissionOptionsCanView;

@property (nonatomic,readonly,assign,getter=createPermissionOptionsFolderId) NSString* createPermissionOptionsFolderId;

- (NSString*)createPermissionOptionsFolderId;

@property (nonatomic,readonly,assign,getter=createPermissionOptionsIsOwner) BOOL createPermissionOptionsIsOwner;

- (BOOL)createPermissionOptionsIsOwner;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsNotifyOnDownload,setter=setCreatePermissionOptionsNotifyOnDownload:) BOOL createPermissionOptionsNotifyOnDownload;

- (BOOL)createPermissionOptionsNotifyOnDownload;
- (void)setCreatePermissionOptionsNotifyOnDownload :(BOOL)newCreatePermissionOptionsNotifyOnDownload;

@property (nonatomic,readwrite,assign,getter=createPermissionOptionsNotifyOnUpload,setter=setCreatePermissionOptionsNotifyOnUpload:) BOOL createPermissionOptionsNotifyOnUpload;

- (BOOL)createPermissionOptionsNotifyOnUpload;
- (void)setCreatePermissionOptionsNotifyOnUpload :(BOOL)newCreatePermissionOptionsNotifyOnUpload;

@property (nonatomic,readonly,assign,getter=createPermissionOptionsUserId) NSString* createPermissionOptionsUserId;

- (NSString*)createPermissionOptionsUserId;

 

Default Value

""

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

EncryptionAlgorithm Property (ShareFile Module)

The encryption algorithm.

Syntax

• Swift
• Objective-C

public var encryptionAlgorithm: SharefileEncryptionAlgorithms {
  get {...}
  set {...}
}

public enum SharefileEncryptionAlgorithms: Int32 {
  case eaAES = 0
  case eaBlowfish = 1
  case eaCAST = 2
  case eaDES = 3
  case eaIDEA = 4
  case eaRC2 = 5
  case eaRC4 = 6
  case eaTEA = 7
  case eaTripleDES = 8
  case eaTwofish = 9
  case eaRijndael = 10
  case eaChaCha = 11
  case eaXSalsa20 = 12
}

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) int encryptionAlgorithm;

- (int)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(int)newEncryptionAlgorithm;

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

The encryption password.

Syntax

• Swift
• Objective-C

public var encryptionPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionPassword,setter=setEncryptionPassword:) NSString* encryptionPassword;

- (NSString*)encryptionPassword;
- (void)setEncryptionPassword :(NSString*)newEncryptionPassword;

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.

Firewall Property (ShareFile Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

Idle Property (ShareFile Module)

The current status of the module.

Syntax

• Swift
• Objective-C

public var idle: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=idle) BOOL idle;

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

ItemData Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var itemData: String {
  get {...}
  set {...}
}

public var itemDataB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=itemData,setter=setItemData:) NSString* itemData;

- (NSString*)itemData;
- (void)setItemData :(NSString*)newItemData;

@property (nonatomic,readwrite,assign,getter=itemDataB,setter=setItemDataB:) NSData* itemDataB;

- (NSData*)itemDataB;
- (void)setItemDataB :(NSData*)newItemData;

Default Value

""

Remarks

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

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

Items Property (ShareFile Module)

A properties of items.

Syntax

• Swift
• Objective-C

public var items: Array<ShareFileItem> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=itemCount,setter=setItemCount:) int itemCount;

- (int)itemCount;
- (void)setItemCount :(int)newItemCount;

- (NSString*)itemCreationDate:(int)itemIndex;

- (NSString*)itemCreatorFirstName:(int)itemIndex;

- (NSString*)itemCreatorLastName:(int)itemIndex;

- (NSString*)itemDescription:(int)itemIndex;
- (void)setItemDescription:(int)itemIndex :(NSString*)newItemDescription;

- (NSString*)itemExpirationDate:(int)itemIndex;
- (void)setItemExpirationDate:(int)itemIndex :(NSString*)newItemExpirationDate;

- (NSString*)itemId:(int)itemIndex;

- (NSString*)itemName:(int)itemIndex;
- (void)setItemName:(int)itemIndex :(NSString*)newItemName;

- (NSString*)itemParentId:(int)itemIndex;
- (void)setItemParentId:(int)itemIndex :(NSString*)newItemParentId;

- (NSString*)itemPath:(int)itemIndex;
- (void)setItemPath:(int)itemIndex :(NSString*)newItemPath;

- (long long)itemSize:(int)itemIndex;

- (int)itemType:(int)itemIndex;

Default Value

""

Remarks

This properties holds a list of file and folder items.

Calling ListItems , ListLinkItems or GetItemInfo will populate this properties.

Links Property (ShareFile Module)

A properties of links.

Syntax

• Swift
• Objective-C

public var links: Array<ShareFileLink> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=linkCount,setter=setLinkCount:) int linkCount;

- (int)linkCount;
- (void)setLinkCount :(int)newLinkCount;

- (int)linkAccessLevel:(int)linkIndex;
- (void)setLinkAccessLevel:(int)linkIndex :(int)newLinkAccessLevel;

- (NSString*)linkCreationDate:(int)linkIndex;

- (NSString*)linkExpirationDate:(int)linkIndex;
- (void)setLinkExpirationDate:(int)linkIndex :(NSString*)newLinkExpirationDate;

- (NSString*)linkId:(int)linkIndex;

- (BOOL)linkIsViewOnly:(int)linkIndex;
- (void)setLinkIsViewOnly:(int)linkIndex :(BOOL)newLinkIsViewOnly;

- (int)linkMaxDownloads:(int)linkIndex;
- (void)setLinkMaxDownloads:(int)linkIndex :(int)newLinkMaxDownloads;

- (BOOL)linkNotifyOnAccess:(int)linkIndex;
- (void)setLinkNotifyOnAccess:(int)linkIndex :(BOOL)newLinkNotifyOnAccess;

- (NSString*)linkTitle:(int)linkIndex;
- (void)setLinkTitle:(int)linkIndex :(NSString*)newLinkTitle;

- (int)linkTotalDownloads:(int)linkIndex;

- (int)linkType:(int)linkIndex;

- (NSString*)linkURL:(int)linkIndex;

Default Value

""

Remarks

This properties holds a list of links.

Calling ListLinks or GetLinkInfo will populate this properties.

LocalFile Property (ShareFile Module)

The location of the local file.

Syntax

• Swift
• Objective-C

public var localFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;

- (NSString*)localFile;
- (void)setLocalFile :(NSString*)newLocalFile;

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.

LocalHost Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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 Module)

This property holds the OAuth Settings.

Syntax

• Swift
• Objective-C

public var oAuth: OAuthSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=OAuthAccessToken,setter=setOAuthAccessToken:) NSString* OAuthAccessToken;

- (NSString*)OAuthAccessToken;
- (void)setOAuthAccessToken :(NSString*)newOAuthAccessToken;

@property (nonatomic,readwrite,assign,getter=OAuthAuthorizationCode,setter=setOAuthAuthorizationCode:) NSString* OAuthAuthorizationCode;

- (NSString*)OAuthAuthorizationCode;
- (void)setOAuthAuthorizationCode :(NSString*)newOAuthAuthorizationCode;

@property (nonatomic,readwrite,assign,getter=OAuthAuthorizationScope,setter=setOAuthAuthorizationScope:) NSString* OAuthAuthorizationScope;

- (NSString*)OAuthAuthorizationScope;
- (void)setOAuthAuthorizationScope :(NSString*)newOAuthAuthorizationScope;

@property (nonatomic,readwrite,assign,getter=OAuthClientId,setter=setOAuthClientId:) NSString* OAuthClientId;

- (NSString*)OAuthClientId;
- (void)setOAuthClientId :(NSString*)newOAuthClientId;

@property (nonatomic,readwrite,assign,getter=OAuthClientProfile,setter=setOAuthClientProfile:) int OAuthClientProfile;

- (int)OAuthClientProfile;
- (void)setOAuthClientProfile :(int)newOAuthClientProfile;

@property (nonatomic,readwrite,assign,getter=OAuthClientSecret,setter=setOAuthClientSecret:) NSString* OAuthClientSecret;

- (NSString*)OAuthClientSecret;
- (void)setOAuthClientSecret :(NSString*)newOAuthClientSecret;

@property (nonatomic,readwrite,assign,getter=OAuthGrantType,setter=setOAuthGrantType:) int OAuthGrantType;

- (int)OAuthGrantType;
- (void)setOAuthGrantType :(int)newOAuthGrantType;

@property (nonatomic,readwrite,assign,getter=OAuthRefreshToken,setter=setOAuthRefreshToken:) NSString* OAuthRefreshToken;

- (NSString*)OAuthRefreshToken;
- (void)setOAuthRefreshToken :(NSString*)newOAuthRefreshToken;

@property (nonatomic,readwrite,assign,getter=OAuthReturnURL,setter=setOAuthReturnURL:) NSString* OAuthReturnURL;

- (NSString*)OAuthReturnURL;
- (void)setOAuthReturnURL :(NSString*)newOAuthReturnURL;

@property (nonatomic,readwrite,assign,getter=OAuthServerAuthURL,setter=setOAuthServerAuthURL:) NSString* OAuthServerAuthURL;

- (NSString*)OAuthServerAuthURL;
- (void)setOAuthServerAuthURL :(NSString*)newOAuthServerAuthURL;

@property (nonatomic,readwrite,assign,getter=OAuthServerTokenURL,setter=setOAuthServerTokenURL:) NSString* OAuthServerTokenURL;

- (NSString*)OAuthServerTokenURL;
- (void)setOAuthServerTokenURL :(NSString*)newOAuthServerTokenURL;

@property (nonatomic,readonly,assign,getter=OAuthWebAuthURL) NSString* OAuthWebAuthURL;

- (NSString*)OAuthWebAuthURL;

 

Default Value

""

Remarks

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

OtherHeaders Property (ShareFile Module)

This property includes other headers as determined by the user (optional).

Syntax

• Swift
• Objective-C

public var otherHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=otherHeaders,setter=setOtherHeaders:) NSString* otherHeaders;

- (NSString*)otherHeaders;
- (void)setOtherHeaders :(NSString*)newOtherHeaders;

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 .

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.

Overwrite Property (ShareFile Module)

Whether to overwrite the local or remote file.

Syntax

• Swift
• Objective-C

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

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

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

Syntax

• Swift
• Objective-C

public var parsedHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=parsedHeaderCount) int parsedHeaderCount;

- (int)parsedHeaderCount;

- (NSString*)parsedHeaderField:(int)parsedHeaderIndex;

- (NSString*)parsedHeaderValue:(int)parsedHeaderIndex;

Default Value

""

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.

Permissions Property (ShareFile Module)

A properties of permissions.

Syntax

• Swift
• Objective-C

public var permissions: Array<ShareFilePermission> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=permissionCount,setter=setPermissionCount:) int permissionCount;

- (int)permissionCount;
- (void)setPermissionCount :(int)newPermissionCount;

- (BOOL)permissionCanDelete:(int)permissionIndex;
- (void)setPermissionCanDelete:(int)permissionIndex :(BOOL)newPermissionCanDelete;

- (BOOL)permissionCanDownload:(int)permissionIndex;
- (void)setPermissionCanDownload:(int)permissionIndex :(BOOL)newPermissionCanDownload;

- (BOOL)permissionCanManagePermissions:(int)permissionIndex;
- (void)setPermissionCanManagePermissions:(int)permissionIndex :(BOOL)newPermissionCanManagePermissions;

- (BOOL)permissionCanUpload:(int)permissionIndex;
- (void)setPermissionCanUpload:(int)permissionIndex :(BOOL)newPermissionCanUpload;

- (BOOL)permissionCanView:(int)permissionIndex;
- (void)setPermissionCanView:(int)permissionIndex :(BOOL)newPermissionCanView;

- (NSString*)permissionFolderId:(int)permissionIndex;

- (BOOL)permissionIsOwner:(int)permissionIndex;

- (BOOL)permissionNotifyOnDownload:(int)permissionIndex;
- (void)setPermissionNotifyOnDownload:(int)permissionIndex :(BOOL)newPermissionNotifyOnDownload;

- (BOOL)permissionNotifyOnUpload:(int)permissionIndex;
- (void)setPermissionNotifyOnUpload:(int)permissionIndex :(BOOL)newPermissionNotifyOnUpload;

- (NSString*)permissionUserId:(int)permissionIndex;

Default Value

""

Remarks

This properties holds a list of permissions.

Calling ListPermissions or GetPermissionInfo will populate this properties.

Proxy Property (ShareFile Module)

This property includes a set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

QueryParams Property (ShareFile Module)

Additional query parameters to be included in the request.

Syntax

• Swift
• Objective-C

public var queryParams: Array<QueryParam> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=queryParamCount,setter=setQueryParamCount:) int queryParamCount;

- (int)queryParamCount;
- (void)setQueryParamCount :(int)newQueryParamCount;

- (NSString*)queryParamName:(int)queryParamIndex;
- (void)setQueryParamName:(int)queryParamIndex :(NSString*)newQueryParamName;

- (NSString*)queryParamValue:(int)queryParamIndex;
- (void)setQueryParamValue:(int)queryParamIndex :(NSString*)newQueryParamValue;

Default Value

""

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

The resumable upload URL.

Syntax

• Swift
• Objective-C

public var resumeURL: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=resumeURL,setter=setResumeURL:) NSString* resumeURL;

- (NSString*)resumeURL;
- (void)setResumeURL :(NSString*)newResumeURL;

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 and UploadFile is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See UploadFile for details.

SearchMarker Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var searchMarker: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=searchMarker,setter=setSearchMarker:) int searchMarker;

- (int)searchMarker;
- (void)setSearchMarker :(int)newSearchMarker;

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.

SSLAcceptServerCertEncoded Property (ShareFile Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (ShareFile Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (ShareFile Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

SSLCertStorePassword Property (ShareFile Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

SSLCertStoreType Property (ShareFile Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: SharefileSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum SharefileSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

SSLCertSubject Property (ShareFile Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (ShareFile Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: SharefileSSLProviders {
  get {...}
  set {...}
}

public enum SharefileSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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:

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 will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (ShareFile Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

StartByte Property (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public var startByte: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=startByte,setter=setStartByte:) long long startByte;

- (long long)startByte;
- (void)setStartByte :(long long)newStartByte;

Default Value

0

Remarks

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

Timeout Property (ShareFile Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 Module)

Whether to use resumable uploads.

Syntax

• Swift
• Objective-C

public var useResumableUpload: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useResumableUpload,setter=setUseResumableUpload:) BOOL useResumableUpload;

- (BOOL)useResumableUpload;
- (void)setUseResumableUpload :(BOOL)newUseResumableUpload;

Default Value

False

Remarks

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

Refer to UploadFile for more information.

Users Property (ShareFile Module)

A properties of users.

Syntax

• Swift
• Objective-C

public var users: Array<ShareFileUser> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=userCount,setter=setUserCount:) int userCount;

- (int)userCount;
- (void)setUserCount :(int)newUserCount;

- (NSString*)userCompany:(int)userIndex;
- (void)setUserCompany:(int)userIndex :(NSString*)newUserCompany;

- (NSString*)userCreationDate:(int)userIndex;

- (NSString*)userEmail:(int)userIndex;
- (void)setUserEmail:(int)userIndex :(NSString*)newUserEmail;

- (NSString*)userFirstName:(int)userIndex;
- (void)setUserFirstName:(int)userIndex :(NSString*)newUserFirstName;

- (NSString*)userId:(int)userIndex;

- (NSString*)userLastName:(int)userIndex;
- (void)setUserLastName:(int)userIndex :(NSString*)newUserLastName;

Default Value

""

Remarks

This properties holds a list of users.

Calling ListUsers or GetUserInfo will populate this properties.

AddQueryParam Method (ShareFile Module)

Adds a query parameter to the QueryParams properties.

Syntax

• Swift
• Objective-C

public func addQueryParam(name: String, value: String) throws -> Void

- (void)addQueryParam:(NSString*)name :(NSString*)value;

Remarks

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

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

Authorize Method (ShareFile Module)

Get the authorization string required to access the protected resource.

Syntax

• Swift
• Objective-C

public func authorize() throws -> Void

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

For more information, see the introduction section.

CalcAuthorization Method (ShareFile Module)

Calculates the Authorization header based on provided credentials.

Syntax

• Swift
• Objective-C

public func calcAuthorization() throws -> Void

- (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 Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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 Module)

Copies the specified item into the specified directory.

Syntax

• Swift
• Objective-C

public func copyItem(itemId: String, parentId: String) throws -> String

- (NSString*)copyItem:(NSString*)itemId :(NSString*)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 Item* properties will be updated with the copied item.

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

• favorites
• allshared
• connectors
• box
• top

CreateAndEmailLink Method (ShareFile Module)

Creates a link for specified items and emails it.

Syntax

• Swift
• Objective-C

public func createAndEmailLink(itemIds: String, emails: String, subject: String, note: String) throws -> String

- (NSString*)createAndEmailLink:(NSString*)itemIds :(NSString*)emails :(NSString*)subject :(NSString*)note;

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new link. After doing so it will also send the emails with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note is added as a note within the body of the email. CreateLinkOptions* properties 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 Module)

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

Syntax

• Swift
• Objective-C

public func createAndEmailRequestLink(folderId: String, emails: String, subject: String, note: String) throws -> String

- (NSString*)createAndEmailRequestLink:(NSString*)folderId :(NSString*)emails :(NSString*)subject :(NSString*)note;

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new request link. After doing so it will also send the emails with the new request link. FolderId is the ID of the directory where the files will be uploaded in ShareFile. emails is a comma separated list of emails. subject is the subject of the email that is sent out. note id added as a note within the body of the email. The CreateLinkOptions* properties 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 Module)

Creates a new client.

Syntax

• Swift
• Objective-C

public func createClient(firstName: String, lastName: String, email: String, company: String) throws -> String

- (NSString*)createClient:(NSString*)firstName :(NSString*)lastName :(NSString*)email :(NSString*)company;

Remarks

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

CreateFolder Method (ShareFile Module)

Creates a new folder.

Syntax

• Swift
• Objective-C

public func createFolder(name: String, parentId: String) throws -> String

- (NSString*)createFolder:(NSString*)name :(NSString*)parentId;

Remarks

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

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

• favorites
• allshared
• connectors
• box
• top

CreateLink Method (ShareFile Module)

Creates a new link for specified items.

Syntax

• Swift
• Objective-C

public func createLink(itemIds: String) throws -> String

- (NSString*)createLink:(NSString*)itemIds;

Remarks

This method will create a new link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new link. ItemIds should be specified as a comma-separated list of one or more item Ids. The CreateLinkOptions* properties 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 Module)

Create a new Permissions for the specified folder and user.

Syntax

• Swift
• Objective-C

public func createPermission(folderId: String, userId: String, recursive: Bool) throws -> Void

- (void)createPermission:(NSString*)folderId :(NSString*)userId :(BOOL)recursive;

Remarks

Creates a new permission for a specified folder and user. The Permission* properties will not be updated with the new permission until the ListPermissions or GetPermissionInfo methods are called. FolderId is the id of the folder to add the permission to. UserId is the id of the user who will be getting the new permission. Recursive is to true when the user needs permission for all sub-folders within the specified folder. The CreatePermissionOptions* properties 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 Permission* properties. 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 Module)

Creates a new request link.

Syntax

• Swift
• Objective-C

public func createRequestLink(folderId: String) throws -> String

- (NSString*)createRequestLink:(NSString*)folderId;

Remarks

This method will create a new request link. The method will then fire the LinkList event, and will populate the Link* properties (clearing any previously-held items in the process) with the new request link. It will also return the new request link as a string. FolderId is the ID for the directory where the files will be uploaded in ShareFile. The CreateLinkOptions* properties 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 Module)

Removes multiple items from a parent item.

Syntax

• Swift
• Objective-C

public func deleteChildItems(parentId: String, itemIds: String) throws -> Void

- (void)deleteChildItems:(NSString*)parentId :(NSString*)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 Module)

Deletes a client from the user list.

Syntax

• Swift
• Objective-C

public func deleteClient(userId: String) throws -> Void

- (void)deleteClient:(NSString*)userId;

Remarks

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

DeleteItem Method (ShareFile Module)

Deletes an item permanently.

Syntax

• Swift
• Objective-C

public func deleteItem(itemId: String) throws -> Void

- (void)deleteItem:(NSString*)itemId;

Remarks

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

DeleteLink Method (ShareFile Module)

Deletes the link specified by the LinkId.

Syntax

• Swift
• Objective-C

public func deleteLink(linkId: String) throws -> Void

- (void)deleteLink:(NSString*)linkId;

Remarks

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

DeletePermission Method (ShareFile Module)

Removes a users permissions for a specific folder.

Syntax

• Swift
• Objective-C

public func deletePermission(folderId: String, userId: String) throws -> Void

- (void)deletePermission:(NSString*)folderId :(NSString*)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 Permission* properties. // 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 Module)

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

Syntax

• Swift
• Objective-C

public func downloadFile(itemId: String) throws -> Void

- (void)downloadFile:(NSString*)itemId;

Remarks

The method will download the item specified by the ItemId. If 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 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);

GetItemInfo Method (ShareFile Module)

Gets information about a specific item.

Syntax

• Swift
• Objective-C

public func getItemInfo(itemId: String) throws -> Void

- (void)getItemInfo:(NSString*)itemId;

Remarks

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

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

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

GetLinkInfo Method (ShareFile Module)

Gets information about a specific link.

Syntax

• Swift
• Objective-C

public func getLinkInfo(linkId: String) throws -> Void

- (void)getLinkInfo:(NSString*)linkId;

Remarks

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

GetPermissionInfo Method (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public func getPermissionInfo(folderId: String, userId: String) throws -> Void

- (void)getPermissionInfo:(NSString*)folderId :(NSString*)userId;

Remarks

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

GetUserInfo Method (ShareFile Module)

Gets information about a specific user.

Syntax

• Swift
• Objective-C

public func getUserInfo(userId: String) throws -> Void

- (void)getUserInfo:(NSString*)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 User* properties (clearing any previously-held items in the process). string userId = shareFile.Users.Id; shareFile.getUserInfo(userId);

Interrupt Method (ShareFile Module)

Interrupt the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ListItems Method (ShareFile Module)

Lists the files and folders within a folder.

Syntax

• Swift
• Objective-C

public func listItems(folderId: String) throws -> Void

- (void)listItems:(NSString*)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 Item* properties (clearing any previously-held items in the process).

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

• favorites
• allshared
• connectors
• box
• top

ListLinkItems Method (ShareFile Module)

Lists the files and folders of a link.

Syntax

• Swift
• Objective-C

public func listLinkItems(linkId: String) throws -> Void

- (void)listLinkItems:(NSString*)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 Item* properties (clearing any previously-held items in the process).

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

ListLinks Method (ShareFile Module)

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

Syntax

• Swift
• Objective-C

public func listLinks() throws -> Void

- (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 Link* properties.

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

Lists the permissions of a folder.

Syntax

• Swift
• Objective-C

public func listPermissions(folderId: String) throws -> Void

- (void)listPermissions:(NSString*)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 Permission* properties. string FolderId = shareFile.Items[0].Id; shareFile.ListPermissions(FolderId);

ListUsers Method (ShareFile Module)

Lists the client users of the authenticated account.

Syntax

• Swift
• Objective-C

public func listUsers() throws -> Void

- (void)listUsers;

Remarks

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

MoveItem Method (ShareFile Module)

Moves an item to a different folder.

Syntax

• Swift
• Objective-C

public func moveItem(itemId: String, parentId: String, newName: String) throws -> Void

- (void)moveItem:(NSString*)itemId :(NSString*)parentId :(NSString*)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 Module)

Resets the component to its initial state.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method resets the class to its initial state.

Search Method (ShareFile Module)

Searches for items that match the specified query.

Syntax

• Swift
• Objective-C

public func search(query: String) throws -> Void

- (void)search:(NSString*)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 Item* properties (clearing any previously-held items in the process).

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

shareFile.Search("Test.txt");

SendCustomRequest Method (ShareFile Module)

Sends a custom request to the ShareFile API.

Syntax

• Swift
• Objective-C

public func sendCustomRequest(httpMethod: String, requestPath: String, requestBody: String) throws -> Void

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)requestPath :(NSString*)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 QueryParam* properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by Authorization and OtherHeaders, and the given RequestBody (if non-empty).
3. Stores the response headers in the ParsedHeader* properties, and the response body in 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.

UpdateClient Method (ShareFile Module)

Updates a client's information.

Syntax

• Swift
• Objective-C

public func updateClient(userId: String, firstName: String, lastName: String, email: String, company: String) throws -> Void

- (void)updateClient:(NSString*)userId :(NSString*)firstName :(NSString*)lastName :(NSString*)email :(NSString*)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* properties.

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

Updates an item with new information.

Syntax

• Swift
• Objective-C

public func updateItemInfo(itemId: String) throws -> Void

- (void)updateItemInfo:(NSString*)itemId;

Remarks

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

The following properties can be updated from the ShareFileItem* properties:

• 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 Module)

Updates a request or download link.

Syntax

• Swift
• Objective-C

public func updateLink(linkId: String) throws -> Void

- (void)updateLink:(NSString*)linkId;

Remarks

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

The following properties can be updated from the ShareFileLink* properties:

• 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 Module)

Updates the permission from the Permission* properties.

Syntax

• Swift
• Objective-C

public func updatePermission(index: Int32, recursive: Bool) throws -> Void

- (void)updatePermission:(int)index :(BOOL)recursive;

Remarks

The permission at Index in the Permission* properties will be updated.

The following properties can be updated from the Permission* properties:

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

UploadFile Method (ShareFile Module)

Will upload a file to a folder.

Syntax

• Swift
• Objective-C

public func uploadFile(fileName: String, parentId: String) throws -> String

- (NSString*)uploadFile:(NSString*)fileName :(NSString*)parentId;

Remarks

The method when called will upload a file specified in the LocalFile property. If LocalFile has not been set 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 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 . 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 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). 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");

EndTransfer Event (ShareFile Module)

This event fires when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(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 Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

ErrorCode contains an error code and Description 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 Module)

Fires after each fragment of a resumable upload is completed.

Syntax

• Swift
• Objective-C

func onFragmentComplete(fragmentNumber: Int32, fragmentCount: Int32, interrupt: inout Bool)

- (void)onFragmentComplete:(int)fragmentNumber :(int)fragmentCount :(int*)interrupt;

Remarks

When UseResumableUpload is 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 to interrupt the upload. The upload may be resumed later.

Header Event (ShareFile Module)

This event is fired every time a header line comes in.

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)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 Module)

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

Syntax

• Swift
• Objective-C

func onItemList(id: String, name: String, path: String, creatorFirstName: String, creatorLastName: String, itemType: Int32, parentId: String, description: String, expirationDate: String, creationDate: String, size: Int64)

- (void)onItemList:(NSString*)id :(NSString*)name :(NSString*)path :(NSString*)creatorFirstName :(NSString*)creatorLastName :(int)itemType :(NSString*)parentId :(NSString*)description :(NSString*)expirationDate :(NSString*)creationDate :(long 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 Module)

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

Syntax

• Swift
• Objective-C

func onLinkList(id: String, title: String, url: String, linkType: Int32, accessLevel: Int32, expirationDate: String, creationDate: String, isViewOnly: Bool, maxDownloads: Int32, totalDownloads: Int32, notifyOnAccess: Bool)

- (void)onLinkList:(NSString*)id :(NSString*)title :(NSString*)URL :(int)linkType :(int)accessLevel :(NSString*)expirationDate :(NSString*)creationDate :(BOOL)isViewOnly :(int)maxDownloads :(int)totalDownloads :(BOOL)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 Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires 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 Module)

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

Syntax

• Swift
• Objective-C

func onPermissionList(folderId: String, userId: String, canDelete: Bool, canDownload: Bool, canManagePermissions: Bool, canUpload: Bool, canView: Bool, isOwner: Bool, notifyOnDownload: Bool, notifyOnUpload: Bool)

- (void)onPermissionList:(NSString*)folderId :(NSString*)userId :(BOOL)canDelete :(BOOL)canDownload :(BOOL)canManagePermissions :(BOOL)canUpload :(BOOL)canView :(BOOL)isOwner :(BOOL)notifyOnDownload :(BOOL)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 Module)

Fires during an upload or download to indicate transfer progress.

Syntax

• Swift
• Objective-C

func onProgress(direction: Int32, bytesTransferred: Int64, totalBytes: Int64, percentDone: Int32)

- (void)onProgress:(int)direction :(long long)bytesTransferred :(long long)totalBytes :(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 Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (ShareFile Module)

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

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(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 Module)

This event is fired while a document transfers (delivers document).

Syntax

• Swift
• Objective-C

func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data)

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)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 Module)

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

Syntax

• Swift
• Objective-C

func onUserList(id: String, firstName: String, lastName: String, company: String, email: String, creationDate: String)

- (void)onUserList:(NSString*)id :(NSString*)firstName :(NSString*)lastName :(NSString*)company :(NSString*)email :(NSString*)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 ("").

Firewall Type

This is the firewall the component will connect through.

Remarks

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

Fields

Constructors

public init()

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 , and its corresponding .

Fields

Constructors

public init()

public init(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 init()

Proxy Type

This is the proxy the component will connect to.

Remarks

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

Fields

Constructors

public init()

public init(server: , port: )

public init(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 init()

public init(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 init()

ShareFileLink Type

A ShareFile share link.

Remarks

Represents a share link retrieved from ShareFile.

Fields

Constructors

public init()

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 init()

ShareFileUser Type

A ShareFile user.

Remarks

Represents a ShareFile user.

Fields

Constructors

public init()

Config Settings (ShareFile Module)

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"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (ShareFile Module)

Common Errors

HTTP Errors

TCPClient Errors

SSL Errors