ShareFile Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class 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 o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token 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 o_auth_access_token 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 o_auth_access_token. 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 o_auth_grant_type 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 o_auth_grant_type 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 o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url 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 o_auth_authorization_code 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 o_auth_refresh_token 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 o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url 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 o_auth_grant_type the class requires OAuthPasswordGrantUsername, o_auth_client_secret, and o_auth_server_token_url to be set. The o_auth_client_secret should be set to the password of the account instead of a typical secret. In some cases, the o_auth_client_id 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 o_auth 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 create_client or create_folder or uploaded with the upload_file 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 create_and_email_link , create_and_email_request_link, create_link, or create_request_link 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 create_permission 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 list_links and list_users 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. list_items will list the items in the folder to the Items* properties. The method will not recursively list out items found in child folders. The list_permissions 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 list_link_items 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. get_item_info, get_link_info and get_user_info each take a corresponding id. For permissions, get_permission_info 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 on_item_list event will fire when the list_items, list_link_items, or get_item_info methods are called; the on_link_list event will fire when the list_links or get_link_info methods are called; the on_permission_list event will fire when the list_permissions or get_permission_info methods are called; and the on_user_list event will fire when the list_users or get_user_info methods are called.

Downloading Files

The download_file method downloads file or folder items.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by item_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

Simple Download

A simple download is consistent with setting the local_file 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 upload_file method uploads new file items.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in item_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

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 use_resumable_upload to True. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. Once called and the class fragments the file, the resume_url 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 on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte 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 resume_url and start_byte 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 upload_file again to resume the upload at the specified start_byte 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 encryption_algorithm and encryption_password properties.
• Basic file and folder manipulation and organization using methods such as copy_item and move_item.
• And more!

Property List

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

Method List

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

Event List

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

Config Settings

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

account_subdomain Property

Represent a ShareFile domain for the account.

Syntax

def get_account_subdomain() -> str: ...
def set_account_subdomain(value: str) -> None: ...

account_subdomain = property(get_account_subdomain, set_account_subdomain)

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

OAuth 2.0 Authorization Token.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

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

create_link_options_access_level Property

The access level for the link.

Syntax

def get_create_link_options_access_level() -> int: ...
def set_create_link_options_access_level(value: int) -> None: ...

create_link_options_access_level = property(get_create_link_options_access_level, set_create_link_options_access_level)

Default Value

0

Remarks

The access level for the link.

This property reflects the link's access level. Possible values are:

• 0 (sflalAnonymous)
• 1 (sflalUserInfo)*
• 2 (sflalEmployeesAndClients)
• 3 (sflalEmployeesOnly)

create_link_options_creation_date Property

The date the link was created.

Syntax

def get_create_link_options_creation_date() -> str: ...

create_link_options_creation_date = property(get_create_link_options_creation_date, None)

Default Value

""

Remarks

The date the link was created.

This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time.

This property is read-only.

create_link_options_expiration_date Property

The expiration date for the link.

Syntax

def get_create_link_options_expiration_date() -> str: ...
def set_create_link_options_expiration_date(value: str) -> None: ...

create_link_options_expiration_date = property(get_create_link_options_expiration_date, set_create_link_options_expiration_date)

Default Value

""

Remarks

The expiration date for the link.

This property specifies the expiration date for when the link will no longer be valid. To modify this property see update_link.

create_link_options_id Property

The id of the link.

Syntax

def get_create_link_options_id() -> str: ...

create_link_options_id = property(get_create_link_options_id, None)

Default Value

""

Remarks

The id of the link.

This property specifies the id of the link.

This property is read-only.

create_link_options_is_view_only Property

If the share items can only be viewed.

Syntax

def get_create_link_options_is_view_only() -> bool: ...
def set_create_link_options_is_view_only(value: bool) -> None: ...

create_link_options_is_view_only = property(get_create_link_options_is_view_only, set_create_link_options_is_view_only)

Default Value

FALSE

Remarks

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

create_link_options_max_downloads Property

The maximum downloads for a link.

Syntax

def get_create_link_options_max_downloads() -> int: ...
def set_create_link_options_max_downloads(value: int) -> None: ...

create_link_options_max_downloads = property(get_create_link_options_max_downloads, set_create_link_options_max_downloads)

Default Value

-1

Remarks

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see update_link.

create_link_options_notify_on_access Property

If the creator is notified when a user accesses the link.

Syntax

def get_create_link_options_notify_on_access() -> bool: ...
def set_create_link_options_notify_on_access(value: bool) -> None: ...

create_link_options_notify_on_access = property(get_create_link_options_notify_on_access, set_create_link_options_notify_on_access)

Default Value

FALSE

Remarks

If the creator is notified when a user accesses the link.

This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to get_link_info or list_links.

create_link_options_title Property

The title of the link.

Syntax

def get_create_link_options_title() -> str: ...
def set_create_link_options_title(value: str) -> None: ...

create_link_options_title = property(get_create_link_options_title, set_create_link_options_title)

Default Value

""

Remarks

The title of the link.

This property specifies the title of the link. To modify this property see update_item_info.

create_link_options_total_downloads Property

Total number of times the link has been downloaded from.

Syntax

def get_create_link_options_total_downloads() -> int: ...

create_link_options_total_downloads = property(get_create_link_options_total_downloads, None)

Default Value

0

Remarks

Total number of times the link has been downloaded from.

This property specifies the number of times an item has been downloaded from it.

This property is read-only.

create_link_options_type Property

The link's type.

Syntax

def get_create_link_options_type() -> int: ...

create_link_options_type = property(get_create_link_options_type, None)

Default Value

0

Remarks

The link's type.

This property reflects the link's type. Possible values are:

• 0 (sfltSend)
• 1 (sfltRequest)

This property is read-only.

create_link_options_url Property

The url for the link.

Syntax

def get_create_link_options_url() -> str: ...

create_link_options_url = property(get_create_link_options_url, None)

Default Value

""

Remarks

The url for the link.

This property specifies the url for the link.

This property is read-only.

create_permission_options_can_delete Property

If the user can delete the item or from the item.

Syntax

def get_create_permission_options_can_delete() -> bool: ...
def set_create_permission_options_can_delete(value: bool) -> None: ...

create_permission_options_can_delete = property(get_create_permission_options_can_delete, set_create_permission_options_can_delete)

Default Value

FALSE

Remarks

If the user can delete the item or from the item.

This property defines whether the user can remove items from the item. To modify this property see update_permission.

create_permission_options_can_download Property

If the user can read file content or download the item or from the item.

Syntax

def get_create_permission_options_can_download() -> bool: ...
def set_create_permission_options_can_download(value: bool) -> None: ...

create_permission_options_can_download = property(get_create_permission_options_can_download, set_create_permission_options_can_download)

Default Value

TRUE

Remarks

If the user can read file content or download the item or from the item.

This property defines whether the user can download or read from the item. To modify this property see update_permission.

create_permission_options_can_manage_permissions Property

If the user can configure Access Controls in the item.

Syntax

def get_create_permission_options_can_manage_permissions() -> bool: ...
def set_create_permission_options_can_manage_permissions(value: bool) -> None: ...

create_permission_options_can_manage_permissions = property(get_create_permission_options_can_manage_permissions, set_create_permission_options_can_manage_permissions)

Default Value

FALSE

Remarks

If the user can configure Access Controls in the item.

This property defines whether the user can configure Access Controls for the item. To modify this property see update_permission.

create_permission_options_can_upload Property

Whether the user can upload files to the item.

Syntax

def get_create_permission_options_can_upload() -> bool: ...
def set_create_permission_options_can_upload(value: bool) -> None: ...

create_permission_options_can_upload = property(get_create_permission_options_can_upload, set_create_permission_options_can_upload)

Default Value

FALSE

Remarks

Whether the user can upload files to the item.

This property defines whether the user can upload files to the item. To modify this property see update_permission.

create_permission_options_can_view Property

If the user can view items from the item.

Syntax

def get_create_permission_options_can_view() -> bool: ...
def set_create_permission_options_can_view(value: bool) -> None: ...

create_permission_options_can_view = property(get_create_permission_options_can_view, set_create_permission_options_can_view)

Default Value

TRUE

Remarks

If the user can view items from the item.

This property defines whether the user can view items from this item. To modify this property see update_permission.

create_permission_options_folder_id Property

The item id for the folder whose permissions are being defined.

Syntax

def get_create_permission_options_folder_id() -> str: ...

create_permission_options_folder_id = property(get_create_permission_options_folder_id, None)

Default Value

""

Remarks

The item id for the folder whose permissions are being defined.

This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type.

This property is read-only.

create_permission_options_is_owner Property

If the user is the owner.

Syntax

def get_create_permission_options_is_owner() -> bool: ...

create_permission_options_is_owner = property(get_create_permission_options_is_owner, None)

Default Value

FALSE

Remarks

If the user is the owner.

This property specifies if the user specified by the create_permission_options_user_id property is the owner of the item specified by the create_permission_options_folder_id property.

This property is read-only.

create_permission_options_notify_on_download Property

If the user is notified when the an item is downloaded from the folder.

Syntax

def get_create_permission_options_notify_on_download() -> bool: ...
def set_create_permission_options_notify_on_download(value: bool) -> None: ...

create_permission_options_notify_on_download = property(get_create_permission_options_notify_on_download, set_create_permission_options_notify_on_download)

Default Value

FALSE

Remarks

If the user is notified when the an item is downloaded from the folder.

This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see update_permission.

create_permission_options_notify_on_upload Property

If the user is notified when the an item is uploaded to the folder.

Syntax

def get_create_permission_options_notify_on_upload() -> bool: ...
def set_create_permission_options_notify_on_upload(value: bool) -> None: ...

create_permission_options_notify_on_upload = property(get_create_permission_options_notify_on_upload, set_create_permission_options_notify_on_upload)

Default Value

FALSE

Remarks

If the user is notified when the an item is uploaded to the folder.

This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see update_permission.

create_permission_options_user_id Property

The user's ShareFile id.

Syntax

def get_create_permission_options_user_id() -> str: ...

create_permission_options_user_id = property(get_create_permission_options_user_id, None)

Default Value

""

Remarks

The user's ShareFile id.

This property specifies the user's user id that the permission is for.

This property is read-only.

encryption_algorithm Property

The encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

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:

encryption_password Property

The encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when upload_file or download_file 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_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

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.

item_data Property

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

Syntax

def get_item_data() -> bytes: ...
def set_item_data(value: bytes) -> None: ...

item_data = property(get_item_data, set_item_data)

Default Value

""

Remarks

This property is populated with file data after calling download_file if local_file is not set.

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

item_count Property

The number of records in the Item arrays.

Syntax

def get_item_count() -> int: ...
def set_item_count(value: int) -> None: ...

item_count = property(get_item_count, set_item_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• item_creation_date
• item_creator_first_name
• item_creator_last_name
• item_description
• item_expiration_date
• item_id
• item_name
• item_parent_id
• item_path
• item_size
• item_type

The array indices start at 0 and end at item_count - 1.

item_creation_date Property

The date when the item was created.

Syntax

def get_item_creation_date(item_index: int) -> str: ...

Default Value

""

Remarks

The date when the item was created.

This property specifies the creation date of the item. Dates are formatted according to ISO 8601 and are always in UTC time.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

item_creator_first_name Property

The first name of the creator.

Syntax

def get_item_creator_first_name(item_index: int) -> str: ...

Default Value

""

Remarks

The first name of the creator.

This property specifies first name of the creator.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

item_creator_last_name Property

The last name of the creator.

Syntax

def get_item_creator_last_name(item_index: int) -> str: ...

Default Value

""

Remarks

The last name of the creator.

This property specifies last name of the creator.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

item_description Property

The description of the item.

Syntax

def get_item_description(item_index: int) -> str: ...
def set_item_description(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The description of the item.

This property specifies the description of the item. To modify this property see update_item_info.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_expiration_date Property

The expiration date for the item.

Syntax

def get_item_expiration_date(item_index: int) -> str: ...
def set_item_expiration_date(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The expiration date for the item.

This property specifies the expiration date for the item. After the date ShareFile will move the item into the recycle bin. To modify this property see update_item_info.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_id Property

The id of the item.

Syntax

def get_item_id(item_index: int) -> str: ...

Default Value

""

Remarks

The id of the item.

This property specifies the id for the item.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

item_name Property

The name of the item.

Syntax

def get_item_name(item_index: int) -> str: ...
def set_item_name(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the item.

This property specifies the name of the item. For example, a files name might be example.txt while a folder might be exampleFolder. To modify this field see update_item_info.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_parent_id Property

The id of the parent item.

Syntax

def get_item_parent_id(item_index: int) -> str: ...
def set_item_parent_id(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The id of the parent item.

This property specifies the id of the parent item. For example, if the current item is a file in the exampleFolder folder then the ParentId will be the id of the exampleFolder item. To modify this property see update_item_info.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_path Property

The path to the parent folder for an item.

Syntax

def get_item_path(item_index: int) -> str: ...
def set_item_path(item_index: int, value: str) -> None: ...

Default Value

""

Remarks

The path to the parent folder for an item.

The property specifies the path from the virtual root to the parent folder for an item. This path is determined by ShareFile.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

item_size Property

The size of the item.

Syntax

def get_item_size(item_index: int) -> int: ...

Default Value

0

Remarks

The size of the item.

The property specifies the size of the item. If the item is a file then the size will be in KB and contain the size of the file. If the item is a folder then it will be the size of the children items, recursively.

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

item_type Property

The item's type.

Syntax

def get_item_type(item_index: int) -> int: ...

Default Value

0

Remarks

The item's type.

This property reflects the item's type. Possible values are:

• 0 (sfitFile)
• 1 (sfitFolder)
• 2 (sfitLink)*
• 3 (sfitNote)
• 4 (sfitSymbolicLink)*

The item_index parameter specifies the index of the item in the array. The size of the array is controlled by the item_count property.

This property is read-only.

link_count Property

The number of records in the Link arrays.

Syntax

def get_link_count() -> int: ...
def set_link_count(value: int) -> None: ...

link_count = property(get_link_count, set_link_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• link_access_level
• link_creation_date
• link_expiration_date
• link_id
• link_is_view_only
• link_max_downloads
• link_notify_on_access
• link_title
• link_total_downloads
• link_type
• link_url

The array indices start at 0 and end at link_count - 1.

link_access_level Property

The access level for the link.

Syntax

def get_link_access_level(link_index: int) -> int: ...
def set_link_access_level(link_index: int, value: int) -> None: ...

Default Value

0

Remarks

The access level for the link.

This property reflects the link's access level. Possible values are:

• 0 (sflalAnonymous)
• 1 (sflalUserInfo)*
• 2 (sflalEmployeesAndClients)
• 3 (sflalEmployeesOnly)

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_creation_date Property

The date the link was created.

Syntax

def get_link_creation_date(link_index: int) -> str: ...

Default Value

""

Remarks

The date the link was created.

This property specifies the date when the link was created. Dates are formatted according to ISO 8601 and are always in UTC time.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_expiration_date Property

The expiration date for the link.

Syntax

def get_link_expiration_date(link_index: int) -> str: ...
def set_link_expiration_date(link_index: int, value: str) -> None: ...

Default Value

""

Remarks

The expiration date for the link.

This property specifies the expiration date for when the link will no longer be valid. To modify this property see update_link.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_id Property

The id of the link.

Syntax

def get_link_id(link_index: int) -> str: ...

Default Value

""

Remarks

The id of the link.

This property specifies the id of the link.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_is_view_only Property

If the share items can only be viewed.

Syntax

def get_link_is_view_only(link_index: int) -> bool: ...
def set_link_is_view_only(link_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the share items can only be viewed.

If true, the share items can only be viewed but not downloaded. Requires account preference EnableViewOnly to work. This feature can be enabled for Enterprise accounts by request.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_max_downloads Property

The maximum downloads for a link.

Syntax

def get_link_max_downloads(link_index: int) -> int: ...
def set_link_max_downloads(link_index: int, value: int) -> None: ...

Default Value

-1

Remarks

The maximum downloads for a link.

The property specifies the number of downloads for a link. "-1" indicates an unlimited number of downloads. The field is always "-1" if the type is request. To modify this property see update_link.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_notify_on_access Property

If the creator is notified when a user accesses the link.

Syntax

def get_link_notify_on_access(link_index: int) -> bool: ...
def set_link_notify_on_access(link_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the creator is notified when a user accesses the link.

This property if the creator of the link will be notified when a user accesses the link. Note: When creating the link this property will not be populated until a subsequent call to get_link_info or list_links.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_title Property

The title of the link.

Syntax

def get_link_title(link_index: int) -> str: ...
def set_link_title(link_index: int, value: str) -> None: ...

Default Value

""

Remarks

The title of the link.

This property specifies the title of the link. To modify this property see update_item_info.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

link_total_downloads Property

Total number of times the link has been downloaded from.

Syntax

def get_link_total_downloads(link_index: int) -> int: ...

Default Value

0

Remarks

Total number of times the link has been downloaded from.

This property specifies the number of times an item has been downloaded from it.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_type Property

The link's type.

Syntax

def get_link_type(link_index: int) -> int: ...

Default Value

0

Remarks

The link's type.

This property reflects the link's type. Possible values are:

• 0 (sfltSend)
• 1 (sfltRequest)

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

link_url Property

The url for the link.

Syntax

def get_link_url(link_index: int) -> str: ...

Default Value

""

Remarks

The url for the link.

This property specifies the url for the link.

The link_index parameter specifies the index of the item in the array. The size of the array is controlled by the link_count property.

This property is read-only.

local_file Property

The location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling upload_file and as the destination file when calling download_file.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

o_auth_client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

o_auth_grant_type Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

o_auth_refresh_token Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_return_url Property

The URL where the user (browser) returns after authenticating.

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

The URL of the token server used to obtain the access token.

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

o_auth_web_auth_url Property

The URL to which the user should be re-directed for authorization.

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only.

other_headers Property

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

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

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 content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Whether to overwrite the local or remote file.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

When calling download_file, this property determines if local_file should be overwritten if it already exists.

When calling upload_file, 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.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

permission_count Property

The number of records in the Permission arrays.

Syntax

def get_permission_count() -> int: ...
def set_permission_count(value: int) -> None: ...

permission_count = property(get_permission_count, set_permission_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• permission_can_delete
• permission_can_download
• permission_can_manage_permissions
• permission_can_upload
• permission_can_view
• permission_folder_id
• permission_is_owner
• permission_notify_on_download
• permission_notify_on_upload
• permission_user_id

The array indices start at 0 and end at permission_count - 1.

permission_can_delete Property

If the user can delete the item or from the item.

Syntax

def get_permission_can_delete(permission_index: int) -> bool: ...
def set_permission_can_delete(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the user can delete the item or from the item.

This property defines whether the user can remove items from the item. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_can_download Property

If the user can read file content or download the item or from the item.

Syntax

def get_permission_can_download(permission_index: int) -> bool: ...
def set_permission_can_download(permission_index: int, value: bool) -> None: ...

Default Value

TRUE

Remarks

If the user can read file content or download the item or from the item.

This property defines whether the user can download or read from the item. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_can_manage_permissions Property

If the user can configure Access Controls in the item.

Syntax

def get_permission_can_manage_permissions(permission_index: int) -> bool: ...
def set_permission_can_manage_permissions(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the user can configure Access Controls in the item.

This property defines whether the user can configure Access Controls for the item. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_can_upload Property

Whether the user can upload files to the item.

Syntax

def get_permission_can_upload(permission_index: int) -> bool: ...
def set_permission_can_upload(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the user can upload files to the item.

This property defines whether the user can upload files to the item. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_can_view Property

If the user can view items from the item.

Syntax

def get_permission_can_view(permission_index: int) -> bool: ...
def set_permission_can_view(permission_index: int, value: bool) -> None: ...

Default Value

TRUE

Remarks

If the user can view items from the item.

This property defines whether the user can view items from this item. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_folder_id Property

The item id for the folder whose permissions are being defined.

Syntax

def get_permission_folder_id(permission_index: int) -> str: ...

Default Value

""

Remarks

The item id for the folder whose permissions are being defined.

This property specifies the item id for the folder whose permissions are being defined. It is required for this id to be of a folder type.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

This property is read-only.

permission_is_owner Property

If the user is the owner.

Syntax

def get_permission_is_owner(permission_index: int) -> bool: ...

Default Value

FALSE

Remarks

If the user is the owner.

This property specifies if the user specified by the permission_user_id property is the owner of the item specified by the permission_folder_id property.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

This property is read-only.

permission_notify_on_download Property

If the user is notified when the an item is downloaded from the folder.

Syntax

def get_permission_notify_on_download(permission_index: int) -> bool: ...
def set_permission_notify_on_download(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the user is notified when the an item is downloaded from the folder.

This property specifies if the user will be notified if an item is downloaded from the folder. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_notify_on_upload Property

If the user is notified when the an item is uploaded to the folder.

Syntax

def get_permission_notify_on_upload(permission_index: int) -> bool: ...
def set_permission_notify_on_upload(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

If the user is notified when the an item is uploaded to the folder.

This property specifies if the user will be notified if an item is uploaded to the folder. To modify this property see update_permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_user_id Property

The user's ShareFile id.

Syntax

def get_permission_user_id(permission_index: int) -> str: ...

Default Value

""

Remarks

The user's ShareFile id.

This property specifies the user's user id that the permission is for.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

This property is read-only.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

resume_url Property

The resumable upload URL.

Syntax

def get_resume_url() -> str: ...
def set_resume_url(value: str) -> None: ...

resume_url = property(get_resume_url, set_resume_url)

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when use_resumable_upload is set to True and upload_file is called to initiate a new upload.

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

search_marker Property

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

Syntax

def get_search_marker() -> int: ...
def set_search_marker(value: int) -> None: ...

search_marker = property(get_search_marker, set_search_marker)

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.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

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:

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

start_byte Property

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

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

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 upload_file and download_file for details about resuming uploads and downloads.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

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

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.

use_resumable_upload Property

Whether to use resumable uploads.

Syntax

def get_use_resumable_upload() -> bool: ...
def set_use_resumable_upload(value: bool) -> None: ...

use_resumable_upload = property(get_use_resumable_upload, set_use_resumable_upload)

Default Value

FALSE

Remarks

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

Refer to upload_file for more information.

user_count Property

The number of records in the User arrays.

Syntax

def get_user_count() -> int: ...
def set_user_count(value: int) -> None: ...

user_count = property(get_user_count, set_user_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_company
• user_creation_date
• user_email
• user_first_name
• user_id
• user_last_name

The array indices start at 0 and end at user_count - 1.

user_company Property

The company of the user.

Syntax

def get_user_company(user_index: int) -> str: ...
def set_user_company(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The company of the user.

This property specifies the company of the user. This is an optional field. To modify this property see update_client.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_creation_date Property

The date the user was created.

Syntax

def get_user_creation_date(user_index: int) -> str: ...

Default Value

""

Remarks

The date the user was created.

This property specifies the creation date of the user. Dates are formatted according to ISO 8601 and are always in UTC time.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

This property is read-only.

user_email Property

The email address of the user.

Syntax

def get_user_email(user_index: int) -> str: ...
def set_user_email(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The email address of the user.

This property specifies the email address of the user. To modify this property see update_client.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_first_name Property

The first name of the user.

Syntax

def get_user_first_name(user_index: int) -> str: ...
def set_user_first_name(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The first name of the user.

This property specifies the first name of the user. To modify this property see update_client.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_id Property

The id of the user.

Syntax

def get_user_id(user_index: int) -> str: ...

Default Value

""

Remarks

The id of the user.

This property specifies the id of the user.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

This property is read-only.

user_last_name Property

The last name of the user.

Syntax

def get_user_last_name(user_index: int) -> str: ...
def set_user_last_name(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The last name of the user.

This property specifies the last name of the user. To modify this property see update_client.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

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

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

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 o_auth_client_profile property and the o_auth_grant_type 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.

calc_authorization Method

Calculates the Authorization header based on provided credentials.

Syntax

def calc_authorization() -> None: ...

Remarks

This method calculates the authorization value using the values provided in auth_scheme, 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

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

copy_item Method

Copies the specified item into the specified directory.

Syntax

def copy_item(item_id: str, parent_id: str) -> str: ...

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 list_items or get_item_info 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

create_and_email_link Method

Creates a link for specified items and emails it.

Syntax

def create_and_email_link(item_ids: str, emails: str, subject: str, note: str) -> str: ...

Remarks

This method will create a new link. The method will then fire the on_link_list 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

create_and_email_request_link Method

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

Syntax

def create_and_email_request_link(folder_id: str, emails: str, subject: str, note: str) -> str: ...

Remarks

This method will create a new request link. The method will then fire the on_link_list 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

create_client Method

Creates a new client.

Syntax

def create_client(first_name: str, last_name: str, email: str, company: str) -> str: ...

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

create_folder Method

Creates a new folder.

Syntax

def create_folder(name: str, parent_id: str) -> str: ...

Remarks

Creates a new folder and returns the new folder's itemId as a string. Must call list_items or get_item_info 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

create_link Method

Creates a new link for specified items.

Syntax

def create_link(item_ids: str) -> str: ...

Remarks

This method will create a new link. The method will then fire the on_link_list 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

create_permission Method

Create a new Permissions for the specified folder and user.

Syntax

def create_permission(folder_id: str, user_id: str, recursive: bool) -> None: ...

Remarks

Creates a new permission for a specified folder and user. The Permission* properties will not be updated with the new permission until the list_permissions or get_permission_info 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);

create_request_link Method

Creates a new request link.

Syntax

def create_request_link(folder_id: str) -> str: ...

Remarks

This method will create a new request link. The method will then fire the on_link_list 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

delete_child_items Method

Removes multiple items from a parent item.

Syntax

def delete_child_items(parent_id: str, item_ids: str) -> None: ...

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

delete_client Method

Deletes a client from the user list.

Syntax

def delete_client(user_id: str) -> None: ...

Remarks

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

delete_item Method

Deletes an item permanently.

Syntax

def delete_item(item_id: str) -> None: ...

Remarks

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

delete_link Method

Deletes the link specified by the LinkId.

Syntax

def delete_link(link_id: str) -> None: ...

Remarks

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

delete_permission Method

Removes a users permissions for a specific folder.

Syntax

def delete_permission(folder_id: str, user_id: str) -> None: ...

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

download_file Method

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

Syntax

def download_file(item_id: str) -> None: ...

Remarks

The method will download the item specified by the ItemId. If local_file is set, the file or folder will be saved to the specified location. Otherwise, the class will use the data from the item_data 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 local_file property. If it is set to false, then the class will throw an error if it finds a collision.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by item_data.

To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.

Download Notes

Simple Download

A simple download is consistent with setting the local_file 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);

get_item_info Method

Gets information about a specific item.

Syntax

def get_item_info(item_id: str) -> None: ...

Remarks

Calling this method will fire the on_item_list 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");

get_link_info Method

Gets information about a specific link.

Syntax

def get_link_info(link_id: str) -> None: ...

Remarks

Calling this method will fire the on_link_list 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);

get_permission_info Method

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

Syntax

def get_permission_info(folder_id: str, user_id: str) -> None: ...

Remarks

Calling this method will fire the on_permission_list 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);

get_user_info Method

Gets information about a specific user.

Syntax

def get_user_info(user_id: str) -> None: ...

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

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_items Method

Lists the files and folders within a folder.

Syntax

def list_items(folder_id: str) -> None: ...

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

list_link_items Method

Lists the files and folders of a link.

Syntax

def list_link_items(link_id: str) -> None: ...

Remarks

Lists the items contained within the link. Calling this method will fire the on_item_list 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 list_items method. string linkId = shareFile.Links[0].Id; shareFile.ListLinkItems(linkId);

list_links Method

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

Syntax

def list_links() -> None: ...

Remarks

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

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

list_permissions Method

Lists the permissions of a folder.

Syntax

def list_permissions(folder_id: str) -> None: ...

Remarks

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

list_users Method

Lists the client users of the authenticated account.

Syntax

def list_users() -> None: ...

Remarks

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

move_item Method

Moves an item to a different folder.

Syntax

def move_item(item_id: str, parent_id: str, new_name: str) -> None: ...

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

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

search Method

Searches for items that match the specified query.

Syntax

def search(query: str) -> None: ...

Remarks

This method searches for items that match the given Query parameter. Calling this method will fire the on_item_list 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");

send_custom_request Method

Sends a custom request to the ShareFile API.

Syntax

def send_custom_request(http_method: str, request_path: str, request_body: str) -> None: ...

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 local_file (using the same logic as download_file).

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.

update_client Method

Updates a client's information.

Syntax

def update_client(user_id: str, first_name: str, last_name: str, email: str, company: str) -> None: ...

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

update_item_info Method

Updates an item with new information.

Syntax

def update_item_info(item_id: str) -> None: ...

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.

update_link Method

Updates a request or download link.

Syntax

def update_link(link_id: str) -> None: ...

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

update_permission Method

Updates the permission from the Permission* properties.

Syntax

def update_permission(index: int, recursive: bool) -> None: ...

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

upload_file Method

Will upload a file to a folder.

Syntax

def upload_file(file_name: str, parent_id: str) -> str: ...

Remarks

The method when called will upload a file specified in the local_file property. If local_file has not been set then the class will use the data found in the item_data 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 local_file is set the file will be uploaded from the specified path. If local_file is not set the data in item_data will be used.

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

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 use_resumable_upload to True. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. Once called and the class fragments the file, the resume_url 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 on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte 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 resume_url and start_byte 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 upload_file again to resume the upload at the specified start_byte 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");

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class ShareFileEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class ShareFile:
@property
def on_end_transfer() -> Callable[[ShareFileEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[ShareFileEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer 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.

on_error Event

Information about errors during data delivery.

Syntax

class ShareFileErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class ShareFile:
@property
def on_error() -> Callable[[ShareFileErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[ShareFileErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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.

on_fragment_complete Event

Fires after each fragment of a resumable upload is completed.

Syntax

class ShareFileFragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

  @property
  def fragment_count() -> int: ...

  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class ShareFile:
@property
def on_fragment_complete() -> Callable[[ShareFileFragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[ShareFileFragmentCompleteEventParams], None]) -> None: ...

Remarks

When use_resumable_upload is True and upload_file is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

on_header Event

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

Syntax

class ShareFileHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class ShareFile:
@property
def on_header() -> Callable[[ShareFileHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[ShareFileHeaderEventParams], None]) -> None: ...

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

on_item_list Event

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

Syntax

class ShareFileItemListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def path() -> str: ...

  @property
  def creator_first_name() -> str: ...

  @property
  def creator_last_name() -> str: ...

  @property
  def item_type() -> int: ...

  @property
  def parent_id() -> str: ...

  @property
  def description() -> str: ...

  @property
  def expiration_date() -> str: ...

  @property
  def creation_date() -> str: ...

  @property
  def size() -> int: ...

# In class ShareFile:
@property
def on_item_list() -> Callable[[ShareFileItemListEventParams], None]: ...
@on_item_list.setter
def on_item_list(event_hook: Callable[[ShareFileItemListEventParams], None]) -> None: ...

Remarks

This event fires once for each item returned when either list_items, list_link_items or get_item_info is called. The items cannot be modified from this event.

on_link_list Event

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

Syntax

class ShareFileLinkListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def title() -> str: ...

  @property
  def url() -> str: ...

  @property
  def link_type() -> int: ...

  @property
  def access_level() -> int: ...

  @property
  def expiration_date() -> str: ...

  @property
  def creation_date() -> str: ...

  @property
  def is_view_only() -> bool: ...

  @property
  def max_downloads() -> int: ...

  @property
  def total_downloads() -> int: ...

  @property
  def notify_on_access() -> bool: ...

# In class ShareFile:
@property
def on_link_list() -> Callable[[ShareFileLinkListEventParams], None]: ...
@on_link_list.setter
def on_link_list(event_hook: Callable[[ShareFileLinkListEventParams], None]) -> None: ...

Remarks

This event fires once for each link returned when list_links or get_link_info is called. The link cannot be modified from this event. This event will not show the items related to the specific link when calling list_link_items. Those will be listed using the on_item_list event.

on_log Event

This event fires once for each log message.

Syntax

class ShareFileLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class ShareFile:
@property
def on_log() -> Callable[[ShareFileLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[ShareFileLogEventParams], None]) -> None: ...

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"

on_permission_list Event

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

Syntax

class ShareFilePermissionListEventParams(object):
  @property
  def folder_id() -> str: ...

  @property
  def user_id() -> str: ...

  @property
  def can_delete() -> bool: ...

  @property
  def can_download() -> bool: ...

  @property
  def can_manage_permissions() -> bool: ...

  @property
  def can_upload() -> bool: ...

  @property
  def can_view() -> bool: ...

  @property
  def is_owner() -> bool: ...

  @property
  def notify_on_download() -> bool: ...

  @property
  def notify_on_upload() -> bool: ...

# In class ShareFile:
@property
def on_permission_list() -> Callable[[ShareFilePermissionListEventParams], None]: ...
@on_permission_list.setter
def on_permission_list(event_hook: Callable[[ShareFilePermissionListEventParams], None]) -> None: ...

Remarks

This event fires once for each permission returned when list_permissions or get_permission_info 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.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

class ShareFileProgressEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def total_bytes() -> int: ...

  @property
  def percent_done() -> int: ...

# In class ShareFile:
@property
def on_progress() -> Callable[[ShareFileProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[ShareFileProgressEventParams], None]) -> None: ...

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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class ShareFileSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class ShareFile:
@property
def on_ssl_server_authentication() -> Callable[[ShareFileSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[ShareFileSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class ShareFileSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class ShareFile:
@property
def on_ssl_status() -> Callable[[ShareFileSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[ShareFileSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer Event

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

Syntax

class ShareFileStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class ShareFile:
@property
def on_start_transfer() -> Callable[[ShareFileStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[ShareFileStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.

on_transfer Event

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

Syntax

class ShareFileTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class ShareFile:
@property
def on_transfer() -> Callable[[ShareFileTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[ShareFileTransferEventParams], None]) -> None: ...

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.

on_user_list Event

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

Syntax

class ShareFileUserListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def first_name() -> str: ...

  @property
  def last_name() -> str: ...

  @property
  def company() -> str: ...

  @property
  def email() -> str: ...

  @property
  def creation_date() -> str: ...

# In class ShareFile:
@property
def on_user_list() -> Callable[[ShareFileUserListEventParams], None]: ...
@on_user_list.setter
def on_user_list(event_hook: Callable[[ShareFileUserListEventParams], None]) -> None: ...

Remarks

This event fires once for each user returned when list_users or get_user_info 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 ("").

ShareFile Config Settings

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

ShareFile Errors

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors