Dropbox Class
Properties Methods Events Config Settings Errors
The Dropbox class makes it easy to upload, download, and manage files and folders within Dropbox.
Syntax
class cloudstorage.Dropbox
Remarks
The Dropbox class provides a simple interface to working with Dropbox. Capabilities include uploading and downloading files, strong encryption support, creating folders, moving and copying resources, and more.
Authentication
This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type.
The class has the following defaults:
Authorization Server URL | "https://www.dropbox.com/oauth2/authorize" |
Token Server URL | "https://api.dropboxapi.com/oauth2/token" |
Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.
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.
Example:
Dropbox dropbox = new Dropbox();
dropbox.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication;
dropbox.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode;
dropbox.OAuth.ClientId = CLIENT_ID;
dropbox.OAuth.ClientSecret = CLIENT_SECRET;
dropbox.Config("OAuthWebServerPort=PORT"); // http://localhost:PORT needs to be a registered redirect URL for the app
dropbox.Authorize();
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.
Web Profile
This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, o_auth_server_token_url, and the o_auth_return_url properties to be set. Before calling the authorize method, the o_auth_web_auth_url property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the o_auth_return_url property. The o_auth_return_url property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the o_auth_authorization_code property. Once that is set, the authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the o_auth_refresh_token field is set, or a refresh token is cached, then the authorize method can immediately be called to make a request to the token server to get a new access token.
External OAuth Support
For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like: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.
For Example:
Oauth oauth = new Oauth();
oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode;
oauth.ClientId = "CLIENT_ID";
oauth.ClientSecret = "CLIENT_SECRET";
oauth.ServerAuthURL = "https://www.dropbox.com/oauth2/authorize";
oauth.ServerTokenURL = "https://api.dropboxapi.com/oauth2/token";
oauth.WebServerPort = PORT; // http://localhost:PORT needs to be a registered redirect URL for the app
dropbox.Authorization = oauth.GetAuthorization();
Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
Addressing Resources
Dropbox typically allows resources to be addressed in multiple ways:
- Using a path (e.g., /path/to/resource.txt).
- Using a resource Id (e.g, id:xxxxx).
- Using an Id-based relative path (e.g., id:xxxxx/relative/path/test.txt, where the Id is that of a folder resource).
- For certain methods, using a revision Id (e.g., rev:xxxxx).
Listing Resources
list_resources lists resources within the specified folder. Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.
If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the resources properties.
// ResourceList event handler.
dropbox.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
do {
dropbox.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(dropbox.ResourceMarker));
Downloading Files
The download_file method downloads file resources.
If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.
To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
dropbox.LocalFile = "../MyFile.zip";
dropbox.DownloadFile(dropbox.Resources[0].Id);
Resuming Downloads
The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
dropbox.LocalFile = downloadFile;
dropbox.DownloadFile(dropbox.Resources[0].Id);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
dropbox.StartByte = new FileInfo(downloadFile).Length;
dropbox.DownloadFile(dropbox.Resources[0].Id);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.
If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file.
dropbox.LocalFile = "../MyFile.zip";
dropbox.EncryptionPassword = "password";
dropbox.DownloadFile(dropbox.Resources[0].Id);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
dropbox.StartByte = new FileInfo(dropbox.Config("DownloadTempFile")).Length;
dropbox.DownloadFile(dropbox.Resources[0].Id);
Uploading Files
The upload_file method uploads new file resources.
If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.
To encrypt the file before uploading it, set encryption_algorithm and encryption_password.
Upload Notes
Dropbox 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.
dropbox.LocalFile = "../MyFile.zip";
dropbox.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. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.
When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. upload_session_id is populated with a resumable upload session Id identifying the session (this value may be needed for additional operations if the upload does not complete normally).
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 upload_session_id 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.
dropbox.LocalFile = "../MyFile.zip";
dropbox.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.
dropbox.UploadFile("MyFile.zip");
Additional Functionality
The Dropbox 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_resource, create_folder, delete_resource, and move_resource.
- Support for resource sharing using create_link, list_shared_links, and revoke_link.
- Change tracking with list_changes and wait_for_changes.
- Advanced resource listing using the search method.
- Retrieval of account and space usage details using get_account_info.
- File revision handling with list_revisions and restore_resource.
- 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.
account_country | The country code of the account's user. |
account_display_name | The display name of the account. |
account_email | The email address of the account. |
account_first_name | The first name of the account's user. |
account_id | The Id of the account. |
account_last_name | The last name of the account's user. |
account_team_id | The Id of the account's team. |
account_team_member_id | The team member Id of the account. |
account_team_name | The name of the account's team. |
account_team_total_space | The total amount of space allocated to the account's team. |
account_team_used_space | The amount of space used by the account's team. |
account_total_space | The total amount of space allocated to the account. |
account_type | The account's type. |
account_used_space | The amount of space used by the account. |
authorization | OAuth 2.0 Authorization Token. |
change_marker | A marker indicating what page of changes to return next. |
download_type | The download type to use for file resources. |
encryption_algorithm | The encryption algorithm. |
encryption_password | The encryption password. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of the firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a username if authentication is to be used when connecting through a firewall. |
idle | This property specifies the current status of the class. |
local_file | The location of the local file. |
local_host | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
next_change_marker | A marker indicating what page of changes to return in the future. |
o_auth_access_token | The access token returned by the authorization server. |
o_auth_authorization_code | The authorization code that is exchanged for an access token. |
o_auth_authorization_scope | The scope request or response parameter used during authorization. |
o_auth_client_id | The id of the client assigned when registering the application. |
o_auth_client_profile | The type of client that is requesting authorization. |
o_auth_client_secret | The secret value for the client assigned when registering the application. |
o_auth_grant_type | The OAuth grant type used to acquire an OAuth access token. |
o_auth_refresh_token | Specifies the refresh token received from or sent to the authorization server. |
o_auth_request_refresh_token | Specifies whether the class will request a refresh token during authorization. |
o_auth_return_url | The URL where the user (browser) returns after authenticating. |
o_auth_server_auth_url | The URL of the authorization server. |
o_auth_server_token_url | The URL of the token server used to obtain the access token. |
o_auth_web_auth_url | The URL to which the user should be re-directed for authorization. |
other_headers | This property includes other headers as determined by the user (optional). |
overwrite | Whether to overwrite the local or remote file. |
parsed_header_count | The number of records in the ParsedHeader arrays. |
parsed_header_field | This property contains the name of the HTTP header (this is the same case as it is delivered). |
parsed_header_value | This property contains the header contents. |
proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
proxy_password | This property contains a password if authentication is to be used for the proxy. |
proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a username if authentication is to be used for the proxy. |
query_param_count | The number of records in the QueryParam arrays. |
query_param_name | The name of the query parameter. |
query_param_value | The value of the query parameter. |
resource_data | The data that was downloaded, or that should be uploaded. |
resource_marker | A marker indicating what page of resources to return next. |
resource_count | The number of records in the Resource arrays. |
resource_access_type | The type of access the current user has to the resource. |
resource_client_modified_time | The client-side last modified timestamp of the file resource. |
resource_deleted | Whether the resource has been deleted. |
resource_export_extension | The file extension of the file format that the file resource will be exported as. |
resource_hash | A hash of the file resource's content. |
resource_id | The Id of the resource. |
resource_modified_time | The last modified timestamp of the file resource. |
resource_name | The name of the resource. |
resource_parent_share_id | The shared folder Id of the resource's parent. |
resource_path | The path of the resource. |
resource_revision | The revision Id of the file resource. |
resource_share_id | The shared folder Id of the folder resource. |
resource_size | The size of the file resource. |
resource_type | The resource's type. |
search_categories | Resource categories to restrict the search to. |
search_file_extensions | File extensions to restrict the search to. |
search_kind | The kind of resources to search for. |
search_marker | A marker indicating what page of search results to return next. |
search_names_only | Whether to match against resource names only when searching. |
shared_link_marker | A marker indicating what page of shared links to return next. |
shared_link_count | The number of records in the SharedLink arrays. |
shared_link_can_revoke | Whether the current user has permission to revoke the link. |
shared_link_expires | The expiration timestamp of the link. |
shared_link_id | The Id of the linked resource. |
shared_link_name | The name of the linked resource. |
shared_link_path | The path of the linked resource. |
shared_link_type | The linked resource's type. |
shared_link_url | The URL of the link. |
shared_link_visibility | The visibility of the link. |
ssl_accept_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_accept_server_cert_expiration_date | This is the date the certificate expires. |
ssl_accept_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_accept_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_accept_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_accept_server_cert_issuer | This is the issuer of the certificate. |
ssl_accept_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_accept_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_accept_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_accept_server_cert_public_key | This is the public key of the certificate. |
ssl_accept_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_accept_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_accept_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_accept_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_accept_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_accept_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_accept_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_accept_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_accept_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_accept_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_accept_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_accept_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_accept_server_cert_version | This property contains the certificate's version number. |
ssl_accept_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_cert_expiration_date | This is the date the certificate expires. |
ssl_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | This is the issuer of the certificate. |
ssl_cert_private_key | This is the private key of the certificate (if available). |
ssl_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | This is the public key of the certificate. |
ssl_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | This is the type of certificate store for this certificate. |
ssl_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_cert_usage | This property contains the text description of UsageFlags . |
ssl_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_cert_version | This property contains the certificate's version number. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_provider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
ssl_server_cert_effective_date | This is the date on which this certificate becomes valid. |
ssl_server_cert_expiration_date | This is the date the certificate expires. |
ssl_server_cert_extended_key_usage | This is a comma-delimited list of extended key usage identifiers. |
ssl_server_cert_fingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_server_cert_fingerprint_sha256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_server_cert_issuer | This is the issuer of the certificate. |
ssl_server_cert_private_key | This is the private key of the certificate (if available). |
ssl_server_cert_private_key_available | This property shows whether a PrivateKey is available for the selected certificate. |
ssl_server_cert_private_key_container | This is the name of the PrivateKey container for the certificate (if available). |
ssl_server_cert_public_key | This is the public key of the certificate. |
ssl_server_cert_public_key_algorithm | This property contains the textual description of the certificate's public key algorithm. |
ssl_server_cert_public_key_length | This is the length of the certificate's public key (in bits). |
ssl_server_cert_serial_number | This is the serial number of the certificate encoded as a string. |
ssl_server_cert_signature_algorithm | The property contains the text description of the certificate's signature algorithm. |
ssl_server_cert_store | This is the name of the certificate store for the client certificate. |
ssl_server_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_server_cert_store_type | This is the type of certificate store for this certificate. |
ssl_server_cert_subject_alt_names | This property contains comma-separated lists of alternative subject names for the certificate. |
ssl_server_cert_thumbprint_md5 | This property contains the MD5 hash of the certificate. |
ssl_server_cert_thumbprint_sha1 | This property contains the SHA-1 hash of the certificate. |
ssl_server_cert_thumbprint_sha256 | This property contains the SHA-256 hash of the certificate. |
ssl_server_cert_usage | This property contains the text description of UsageFlags . |
ssl_server_cert_usage_flags | This property contains the flags that show intended use for the certificate. |
ssl_server_cert_version | This property contains the certificate's version number. |
ssl_server_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
start_byte | The byte offset from which to start the upload or download. |
timeout | This property includes the timeout for the class. |
upload_session_id | The Id of the resumable upload session. |
use_resumable_upload | Whether to use resumable uploads. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
add_query_param | Adds a query parameter to the QueryParams properties. |
authorize | Get the authorization string required to access the protected resource. |
calc_authorization | Calculates the Authorization header based on provided credentials. |
config | Sets or retrieves a configuration setting. |
copy_resource | Copies a resource. |
create_folder | Creates a new folder resource. |
create_link | Creates a shared link for a resource. |
delete_resource | Deletes a resource. |
download_file | Downloads a file resource. |
get_account_info | Gets information about the current user's account and space usage. |
get_current_change_marker | Gets the most current change marker. |
get_resource_info | Gets information about a specific resource. |
interrupt | This method interrupts the current method. |
list_changes | Lists changes to resources. |
list_resources | Lists resources. |
list_revisions | Lists revisions for a file path or file resource Id. |
list_shared_links | Lists shared links created by the current user. |
move_resource | Moves a resource. |
reset | Resets the class to its initial state. |
restore_resource | Restores a given file resource revision. |
revoke_link | Revokes a shared link. |
search | Searches for resources. |
send_custom_request | Sends a custom request to the Dropbox API. |
upload_file | Uploads a file resource. |
wait_for_changes | Waits a certain amount of time for changes to occur. |
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.
on_end_transfer | This event fires when a document finishes transferring. |
on_error | Fired when information is available about errors during data delivery. |
on_fragment_complete | Fires after each fragment of a resumable upload is completed. |
on_header | This event is fired every time a header line comes in. |
on_log | This event fires once for each log message. |
on_progress | Fires during an upload or download to indicate transfer progress. |
on_resource_list | Fires once for each resource returned when listing resources, changes, or revisions. |
on_shared_link_list | Fires once for each shared link returned when listing shared links. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
on_start_transfer | This event fires when a document starts transferring (after the headers). |
on_transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AccountHomeNamespace | The current user's home namespace Id. |
AccountHomePath | The path for the current user's home directory, if their account is part of a team. |
AccountRootNamespace | The current user's root namespace Id. |
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
AllowCopySharedFolders | Whether to allow the copying of shared folders or their contents. |
AllowFolderDownloads | Whether to allow folder downloading. |
AllowOwnershipTransfers | Whether to allow move operations that would result in ownership transfers. |
ClientModifiedTime | The client-side last modified time. |
CreateLinkExpiration | The expiration date to assign to the link. |
CreateLinkPassword | The password to protect the link with. |
CreateLinkVisibility | The visibility to create links with. |
DateFormat | The format to use for date and time. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
FragmentSize | The fragment size. |
IfRevision | A revision Id, used to modify certain requests. |
IncludeDeleted | Whether deleted resources should be included in the results. |
IncludeMounted | Whether to include resources in mounted folders in the results. |
ListRevisionsMode | Controls the revision listing mode that the server should use. |
MaxResults | Limits the number of resource and change results. |
MaxRevisionResults | Limits the number of revision results. |
MaxSearchResults | Limits the number of search results. |
MuteFileUploads | Whether the server should suppress file change notifications. |
PermanentlyDelete | Whether resources should be permanently deleted (Dropbox Business only). |
ProgressAbsolute | Whether the class should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
RecurseSubfolders | Whether to recursively list all resources within the specified folder. |
RenameIfExists | Whether to rename newly-created resources in the event of a name conflict. |
TempPath | The path to the directory where temporary files are created. |
ThumbnailFormat | The image format thumbnails should be downloaded in. |
ThumbnailMode | The mode the server should use to create thumbnails. |
ThumbnailSize | The thumbnail output size. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
OAuthAccessTokenExpiration | The lifetime of the access token. |
OAuthAuthorizationTokenType | The type of access token returned. |
OAuthAutomaticRefresh | Whether or not to refresh an expired access token automatically. |
OAuthBrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
OAuthIncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
OAuthJWTPayload | The payload of the JWT access token if present. |
OAuthJWTXChildCount | The number of child elements of the current element. |
OauthJWTXChildName[i] | The name of the child element. |
OAuthJWTXChildXText[i] | The inner text of the child element. |
OAuthJWTXElement | The name of the current element. |
OauthJWTXParent | The parent of the current element. |
OAuthJWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
OAuthJWTXSubTree | A snapshot of the current element in the document. |
OAuthJWTXText | The text of the current element. |
OAuthParamCount | Specifies the number of additional parameters variables to include in the request. |
OAuthParamName[i] | Specifies the parameter name at the specified index. |
OAuthParamValue[i] | Specifies the parameter value at the specified index. |
OAuthPasswordGrantUsername | Used in the Resource Owner Password grant type. |
OAuthPKCEChallengeEncoding | The PKCE code challenge method to use. |
OAuthPKCEVerifier | The PKCE verifier used to generate the challenge. |
OAuthResetData | Determines if the Reset method applies to the OAuth settings. |
OAuthReUseWebServer | Determines if the same server instance is used between requests. |
OAuthTransferredRequest | The full OAuth request last sent by the client. |
OAuthUsePKCE | Specifies if PKCE should be used. |
OAuthWebServerActive | Specifies and controls whether the embedded web server is active. |
OAuthWebServerCertStore | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStorePassword | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertStoreType | The certificate with private key to use when SSL is enabled. |
OAuthWebServerCertSubject | The certificate with private key to use when SSL is enabled. |
OAuthWebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
OAuthWebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
OAuthWebServerPort | The local port on which the embedded web server listens. |
OAuthWebServerResponse | The custom response that will be displayed to the user. |
OAuthWebServerSSLEnabled | Whether the web server requires SSL connections. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
account_country Property
The country code of the account's user.
Syntax
def get_account_country() -> str: ...
account_country = property(get_account_country, None)
Default Value
""
Remarks
The country code of the account's user.
This property reflects the two-letter country code of the account's user, if available. Country codes are based on ISO 3166-1.
This property is read-only.
account_display_name Property
The display name of the account.
Syntax
def get_account_display_name() -> str: ...
account_display_name = property(get_account_display_name, None)
Default Value
""
Remarks
The display name of the account.
This property reflects the display name of the account itself.
This property is read-only.
account_email Property
The email address of the account.
Syntax
def get_account_email() -> str: ...
account_email = property(get_account_email, None)
Default Value
""
Remarks
The email address of the account.
This property reflects the email address associated with the account.
This property is read-only.
account_first_name Property
The first name of the account's user.
Syntax
def get_account_first_name() -> str: ...
account_first_name = property(get_account_first_name, None)
Default Value
""
Remarks
The first name of the account's user.
This property reflects the account user's first name.
This property is read-only.
account_id Property
The Id of the account.
Syntax
def get_account_id() -> str: ...
account_id = property(get_account_id, None)
Default Value
""
Remarks
The Id of the account.
This property reflects the Id of the account.
This property is read-only.
account_last_name Property
The last name of the account's user.
Syntax
def get_account_last_name() -> str: ...
account_last_name = property(get_account_last_name, None)
Default Value
""
Remarks
The last name of the account's user.
This property reflects the account user's last name.
This property is read-only.
account_team_id Property
The Id of the account's team.
Syntax
def get_account_team_id() -> str: ...
account_team_id = property(get_account_team_id, None)
Default Value
""
Remarks
The Id of the account's team.
This property reflects the Id of the account's team, if the account is paired to a team.
This property is read-only.
account_team_member_id Property
The team member Id of the account.
Syntax
def get_account_team_member_id() -> str: ...
account_team_member_id = property(get_account_team_member_id, None)
Default Value
""
Remarks
The team member Id of the account.
This property reflects the team member Id of the account, if the account is paired to a team.
This property is read-only.
account_team_name Property
The name of the account's team.
Syntax
def get_account_team_name() -> str: ...
account_team_name = property(get_account_team_name, None)
Default Value
""
Remarks
The name of the account's team.
This property reflects the name of the account's team, if the account is paired to a team.
This property is read-only.
account_team_total_space Property
The total amount of space allocated to the account's team.
Syntax
def get_account_team_total_space() -> int: ...
account_team_total_space = property(get_account_team_total_space, None)
Default Value
-1
Remarks
The total amount of space allocated to the account's team.
This property reflects the total amount of space, in bytes, allocated to the account's team, if the account is paired to a team.
This property is read-only.
account_team_used_space Property
The amount of space used by the account's team.
Syntax
def get_account_team_used_space() -> int: ...
account_team_used_space = property(get_account_team_used_space, None)
Default Value
-1
Remarks
The amount of space used by the account's team.
This property reflects the amount of space, in bytes, used by the account's team, if the account is paired to a team.
This property is read-only.
account_total_space Property
The total amount of space allocated to the account.
Syntax
def get_account_total_space() -> int: ...
account_total_space = property(get_account_total_space, None)
Default Value
-1
Remarks
The total amount of space allocated to the account.
This property reflects the total amount of space, in bytes, allocated to the account.
If the account is paired to a team, then the value of this property will either reflect the account's total space quota as defined by the team, or (if the account doesn't have a quota) the same value as the account_team_total_space property.
This property is read-only.
account_type Property
The account's type.
Syntax
def get_account_type() -> int: ...
account_type = property(get_account_type, None)
Default Value
0
Remarks
The account's type.
This property reflects the account's type. Possible values are:
- 0 (atBasic)
- 1 (atPro)
- 2 (atBusiness)
This property is read-only.
account_used_space Property
The amount of space used by the account.
Syntax
def get_account_used_space() -> int: ...
account_used_space = property(get_account_used_space, None)
Default Value
-1
Remarks
The amount of space used by the account.
This property reflects the amount of space, in bytes, used by the account.
This property is read-only.
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 o_auth property, using the OAuth class or a separate process. If using the o_auth property, then the authorization property will not be used.
Bearer ACCESS_TOKENAssign this value to the authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
change_marker Property
A marker indicating what page of changes to return next.
Syntax
def get_change_marker() -> str: ... def set_change_marker(value: str) -> None: ...
change_marker = property(get_change_marker, set_change_marker)
Default Value
""
Remarks
This property will be populated when list_changes is called if the results are paged and there are more pages. To list all changes, continue to call list_changes until this property returns empty string.
Setting change_marker will cause next_change_marker to be set to empty string.
Refer to list_changes for more information.
download_type Property
The download type to use for file resources.
Syntax
def get_download_type() -> int: ... def set_download_type(value: int) -> None: ...
download_type = property(get_download_type, set_download_type)
Default Value
0
Remarks
This property controls what the class will download when download_file is called for a file resource. Possible values are:
0 (ddtFileContent - default) | download_file will download the file's contents. |
1 (ddtFileThumbnail) | download_file will download a thumbnail of the file. |
2 (ddtFilePreview) | download_file will download a PDF- or HTML-based preview of the file. |
File thumbnails may be customized using the ThumbnailFormat, ThumbnailMode, and ThumbnailSize configuration settings; and are supported for the following file types: .bmp, .gif, .jpeg, .jpg, .png, .tif, and .tiff.
File previews are supported for the following file types:
- PDF-based: .ai, .doc, .docm, .docx, .eps, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, and .rtf.
- HTML-based: .csv, .ods, .xls, .xlsm, and .xlsx
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:
Algorithm | Key Size |
0 (eaAES - default) | 256 |
1 (eaBlowfish) | 448 |
2 (eaCAST) | 128 |
3 (eaDES) | 64 |
4 (eaIDEA) | 128 |
5 (eaRC2) | 128 |
6 (eaRC4) | 2048 |
7 (eaTEA) | 128 |
8 (eaTripleDES) | 192 |
9 (eaTwofish) | 256 |
10 (eaRijndael) | 256 |
11 (eaChaCha) | 256 |
12 (eaXSalsa20) | 256 |
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:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of the 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 the 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 username if authentication is to be used when 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 username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
idle Property
This property specifies 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 or waiting for an answer), and True at all other times.
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
This property includes 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the 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 multihomed 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.
next_change_marker Property
A marker indicating what page of changes to return in the future.
Syntax
def get_next_change_marker() -> str: ... def set_next_change_marker(value: str) -> None: ...
next_change_marker = property(get_next_change_marker, set_next_change_marker)
Default Value
""
Remarks
This property will be populated when list_changes is called if there are no more changes to list.
This property will be populated with the most current change marker if get_current_change_marker is called.
Setting next_change_marker will cause change_marker to be set to empty string.
Refer to list_changes for more information.
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:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
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:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
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_request_refresh_token Property
Specifies whether the class will request a refresh token during authorization.
Syntax
def get_o_auth_request_refresh_token() -> bool: ... def set_o_auth_request_refresh_token(value: bool) -> None: ...
o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token)
Default Value
TRUE
Remarks
Specifies whether the class will request a refresh token during authorization. By default, this value is True.
When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the o_auth_grant_type property is set to cogtAuthorizationCode.
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 overwritten if it already exists. If the RenameIfExists configuration setting is enabled, this property is ignored and the server will renamed the newly-uploaded file instead (if necessary).
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:
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.
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 properties 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:
psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a username 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 username if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties 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:
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.
resource_data Property
The data that was downloaded, or that should be uploaded.
Syntax
def get_resource_data() -> bytes: ... def set_resource_data(value: bytes) -> None: ...
resource_data = property(get_resource_data, set_resource_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.
resource_marker Property
A marker indicating what page of resources to return next.
Syntax
def get_resource_marker() -> str: ... def set_resource_marker(value: str) -> None: ...
resource_marker = property(get_resource_marker, set_resource_marker)
Default Value
""
Remarks
This property will be populated when list_resources is called if the results are paged and there are more pages. To list all resources, continue to call list_resources until this property returns empty string.
Refer to list_resources for more information.
resource_count Property
The number of records in the Resource arrays.
Syntax
def get_resource_count() -> int: ... def set_resource_count(value: int) -> None: ...
resource_count = property(get_resource_count, set_resource_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- resource_access_type
- resource_client_modified_time
- resource_deleted
- resource_export_extension
- resource_hash
- resource_id
- resource_modified_time
- resource_name
- resource_parent_share_id
- resource_path
- resource_revision
- resource_share_id
- resource_size
- resource_type
resource_access_type Property
The type of access the current user has to the resource.
Syntax
def get_resource_access_type(resource_index: int) -> int: ...
Default Value
0
Remarks
The type of access the current user has to the resource.
This property reflects the type of access the current user has to the resource. Possible values are:
0 (atUnrestricted) | The user's access to the resource is not restricted. |
1 (atReadOnly) | The user has read-only access to the resource. This indicates that the resource is, or is located within, a read-only shared folder. |
2 (atLimited) | The user has limited access to the immediate contents of the folder resource (by virtue of having access to one or more other resources located somewhere within the folder). See further notes below. Only applicable to folders. |
3 (atNoAccess) | The user is allowed to see that the folder resource exists, but may not access its contents. Only applicable to folders. |
An access type of 2 (atLimited) still allows the user to call list_resources for a folder, but the results will be limited to the subset of resources within that folder that the user can actually access (including any further limited-access subfolders).
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_client_modified_time Property
The client-side last modified timestamp of the file resource.
Syntax
def get_resource_client_modified_time(resource_index: int) -> str: ...
Default Value
""
Remarks
The client-side last modified timestamp of the file resource.
This property holds the last modified timestamp of the file resource, as reported by a client. Timestamps are formatted according to ISO 8601 and are always in UTC time.
Not applicable for folder resources. May be empty or inaccurate for file resources if clients choose not to provide a value when uploading or updating the file contents.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_deleted Property
Whether the resource has been deleted.
Syntax
def get_resource_deleted(resource_index: int) -> bool: ...
Default Value
FALSE
Remarks
Whether the resource has been deleted.
This property reflects whether the resource has been deleted.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_export_extension Property
The file extension of the file format that the file resource will be exported as.
Syntax
def get_resource_export_extension(resource_index: int) -> str: ...
Default Value
""
Remarks
The file extension of the file format that the file resource will be exported as.
Some file resources are "export-only"; i.e., they're stored in Dropbox using a server-only file format, and get exported to a "normal" file format when download_file is called. For export-only file resources, this property reflects the file extension of the export file format; it is empty for all other resources.
When downloading an export-only file resource to a local_file, the class will automatically append the file extension reflected by this property, if necessary.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_hash Property
A hash of the file resource's content.
Syntax
def get_resource_hash(resource_index: int) -> str: ...
Default Value
""
Remarks
A hash of the file resource's content.
This property holds a hash of the file resource's content. Not applicable for folder resources.
Refer to the Dropbox API documentation for an explanation of how the server calculates file content hashes.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_id Property
The Id of the resource.
Syntax
def get_resource_id(resource_index: int) -> str: ...
Default Value
""
Remarks
The Id of the resource.
This property reflects the Id of the resource.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_modified_time Property
The last modified timestamp of the file resource.
Syntax
def get_resource_modified_time(resource_index: int) -> str: ...
Default Value
""
Remarks
The last modified timestamp of the file resource.
This property holds the last modified timestamp of the file resource, as reported by the server. Not applicable for folder resources. Timestamps are formatted according to ISO 8601 and are always in UTC time.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_name Property
The name of the resource.
Syntax
def get_resource_name(resource_index: int) -> str: ...
Default Value
""
Remarks
The name of the resource.
This property reflects the name of the resource.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_parent_share_id Property
The shared folder Id of the resource's parent.
Syntax
def get_resource_parent_share_id(resource_index: int) -> str: ...
Default Value
""
Remarks
The shared folder Id of the resource's parent.
This property reflects the shared folder Id of the resource's parent, if its parent is a shared folder.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_path Property
The path of the resource.
Syntax
def get_resource_path(resource_index: int) -> str: ...
Default Value
""
Remarks
The path of the resource.
This property reflects the path of the resource.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_revision Property
The revision Id of the file resource.
Syntax
def get_resource_revision(resource_index: int) -> str: ...
Default Value
""
Remarks
The revision Id of the file resource.
This property reflects the revision Id of the file resource. Not applicable for folder resources.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_share_id Property
The shared folder Id of the folder resource.
Syntax
def get_resource_share_id(resource_index: int) -> str: ...
Default Value
""
Remarks
The shared folder Id of the folder resource.
This property reflects the shared folder Id of the folder resource, if the resource is a shared folder. Not applicable for file resources.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_size Property
The size of the file resource.
Syntax
def get_resource_size(resource_index: int) -> int: ...
Default Value
-1
Remarks
The size of the file resource.
This property holds the size of the file resource, in bytes. Not applicable for folder resources.
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
resource_type Property
The resource's type.
Syntax
def get_resource_type(resource_index: int) -> int: ...
Default Value
0
Remarks
The resource's type.
This property indicates whether the resource is a folder or a file. Possible values are:
0 (drtFile) | A file. |
1 (drtFolder) | A folder. |
The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.
This property is read-only.
search_categories Property
Resource categories to restrict the search to.
Syntax
def get_search_categories() -> str: ... def set_search_categories(value: str) -> None: ...
search_categories = property(get_search_categories, set_search_categories)
Default Value
""
Remarks
This property may be set to a comma-separated list of resource categories to restrict the search results returned by search. Possible categories include:
Category | Associated File Extensions |
image | jpg, png, gif, ... |
document | doc, docx, txt, ... |
spreadsheet | xls, xlsx, csv, ... |
presentation | ppt, pptx, key, ... |
audio | mp3, wav, mid, ... |
video | mov, wmv, mp4, ... |
folder | (Dropbox folders) |
paper | (Dropbox Paper documents) |
others | (all other files) |
The list of valid categories (and their associated file extensions) is defined by Dropbox and may change at any time; refer to the Dropbox API documentation for more information.
Note that the server will only apply this search restriction when search_kind is set to dskActive (0).
search_file_extensions Property
File extensions to restrict the search to.
Syntax
def get_search_file_extensions() -> str: ... def set_search_file_extensions(value: str) -> None: ...
search_file_extensions = property(get_search_file_extensions, set_search_file_extensions)
Default Value
""
Remarks
This property may be set to a comma-separated list of file extensions to restrict the search results returned by search. File extensions should be specified without leading dot (.) characters.
Note that the server will only apply this search restriction when search_kind is set to dskActive (0).
search_kind Property
The kind of resources to search for.
Syntax
def get_search_kind() -> int: ... def set_search_kind(value: int) -> None: ...
search_kind = property(get_search_kind, set_search_kind)
Default Value
0
Remarks
This property specifies what kind of resources to search for when search is called. Possible values are:
dskActive (0) (default) | Search for active resources. |
dskDeleted (1) | Search for deleted resources. |
search_marker Property
A marker indicating what page of search results to return next.
Syntax
def get_search_marker() -> str: ... def set_search_marker(value: str) -> None: ...
search_marker = property(get_search_marker, set_search_marker)
Default Value
""
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 empty string.
Refer to search for more information.
search_names_only Property
Whether to match against resource names only when searching.
Syntax
def get_search_names_only() -> bool: ... def set_search_names_only(value: bool) -> None: ...
search_names_only = property(get_search_names_only, set_search_names_only)
Default Value
FALSE
Remarks
This property indicates whether the server should only match the query string passed to search against resource names. If this property is disabled (default), the server will match the specified query string against resource details and/or content at its discretion.
shared_link_marker Property
A marker indicating what page of shared links to return next.
Syntax
def get_shared_link_marker() -> str: ... def set_shared_link_marker(value: str) -> None: ...
shared_link_marker = property(get_shared_link_marker, set_shared_link_marker)
Default Value
""
Remarks
This property will be populated when list_shared_links is called if the results are paged and there are more pages. To list all shared links, continue to call list_shared_links until this property returns empty string.
Refer to list_shared_links for more information
shared_link_count Property
The number of records in the SharedLink arrays.
Syntax
def get_shared_link_count() -> int: ... def set_shared_link_count(value: int) -> None: ...
shared_link_count = property(get_shared_link_count, set_shared_link_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- shared_link_can_revoke
- shared_link_expires
- shared_link_id
- shared_link_name
- shared_link_path
- shared_link_type
- shared_link_url
- shared_link_visibility
shared_link_can_revoke Property
Whether the current user has permission to revoke the link.
Syntax
def get_shared_link_can_revoke(shared_link_index: int) -> bool: ...
Default Value
FALSE
Remarks
Whether the current user has permission to revoke the link.
This property indicates whether the current user has permission to revoke the link.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_expires Property
The expiration timestamp of the link.
Syntax
def get_shared_link_expires(shared_link_index: int) -> str: ...
Default Value
""
Remarks
The expiration timestamp of the link.
This property holds the expiration timestamp of the link (or empty string, if the link doesn't expire). Timestamps are formatted according to ISO 8601 and are always in UTC time.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_id Property
The Id of the linked resource.
Syntax
def get_shared_link_id(shared_link_index: int) -> str: ...
Default Value
""
Remarks
The Id of the linked resource.
This property reflects the Id of the linked resource.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_name Property
The name of the linked resource.
Syntax
def get_shared_link_name(shared_link_index: int) -> str: ...
Default Value
""
Remarks
The name of the linked resource.
This property reflects the name of the linked resource.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_path Property
The path of the linked resource.
Syntax
def get_shared_link_path(shared_link_index: int) -> str: ...
Default Value
""
Remarks
The path of the linked resource.
This property reflects the path of the linked resource.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_type Property
The linked resource's type.
Syntax
def get_shared_link_type(shared_link_index: int) -> int: ...
Default Value
0
Remarks
The linked resource's type.
This property indicates whether the linked resource is a folder or a file. Possible values are:
0 (lrtFile) | A file. |
1 (lrtFolder) | A folder. |
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_url Property
The URL of the link.
Syntax
def get_shared_link_url(shared_link_index: int) -> str: ...
Default Value
""
Remarks
The URL of the link.
This property reflects the URL of the link.
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
shared_link_visibility Property
The visibility of the link.
Syntax
def get_shared_link_visibility(shared_link_index: int) -> int: ...
Default Value
0
Remarks
The visibility of the link.
This property reflects the visibility of the link. Possible values are:
0 (lvPublic) | Anyone with the link can access the linked resource. |
1 (lvTeamOnly) | Only members of the same team with the link can access the linked resource. (Only applicable to Dropbox Business.) |
2 (lvPassword) | Anyone with the link and the link's password can access the linked resource. |
3 (lvTeamAndPassword) | Only members of the same team with the link and the link's password can access the linked resource. (Only applicable to Dropbox Business.) |
4 (lvSharedFolderOnly) | Only members (with the link) of the shared folder containing the linked resource can access it. |
The shared_link_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_link_count property.
This property is read-only.
ssl_accept_server_cert_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_accept_server_cert_effective_date() -> str: ...
ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_accept_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_accept_server_cert_expiration_date() -> str: ...
ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_accept_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_accept_server_cert_extended_key_usage() -> str: ...
ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_accept_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint() -> str: ...
ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_accept_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...
ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_accept_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...
ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_accept_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_accept_server_cert_issuer() -> str: ...
ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_accept_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key() -> str: ...
ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.
This property is read-only.
ssl_accept_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_accept_server_cert_private_key_available() -> bool: ...
ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_accept_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_accept_server_cert_private_key_container() -> str: ...
ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_accept_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_accept_server_cert_public_key() -> str: ...
ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_accept_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...
ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_accept_server_cert_public_key_length() -> int: ...
ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_accept_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_accept_server_cert_serial_number() -> str: ...
ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_accept_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_accept_server_cert_signature_algorithm() -> str: ...
ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_accept_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ...
ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password protected, specify the password in ssl_accept_server_cert_store_password.
ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
ssl_accept_server_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_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ...
ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ...
ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_accept_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_accept_server_cert_subject_alt_names() -> str: ...
ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_accept_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...
ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...
ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...
ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_accept_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_accept_server_cert_usage() -> str: ...
ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_accept_server_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_accept_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_accept_server_cert_usage_flags() -> int: ...
ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_accept_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_accept_server_cert_version() -> str: ...
ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_accept_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ...
ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
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_provider Property
This property specifies the Secure Sockets Layer/Transport Layer Security (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 as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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_effective_date Property
This is the date on which this certificate becomes valid.
Syntax
def get_ssl_server_cert_effective_date() -> str: ...
ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_server_cert_expiration_date Property
This is the date the certificate expires.
Syntax
def get_ssl_server_cert_expiration_date() -> str: ...
ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_server_cert_extended_key_usage Property
This is a comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_server_cert_extended_key_usage() -> str: ...
ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_server_cert_fingerprint Property
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint() -> str: ...
ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_server_cert_fingerprint_sha1 Property
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha1() -> str: ...
ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_server_cert_fingerprint_sha256 Property
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_server_cert_fingerprint_sha256() -> str: ...
ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_server_cert_issuer Property
This is the issuer of the certificate.
Syntax
def get_ssl_server_cert_issuer() -> str: ...
ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_server_cert_private_key Property
This is the private key of the certificate (if available).
Syntax
def get_ssl_server_cert_private_key() -> str: ...
ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.
This property is read-only.
ssl_server_cert_private_key_available Property
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_server_cert_private_key_available() -> bool: ...
ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)
Default Value
FALSE
Remarks
This property shows whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_server_cert_private_key_container Property
This is the name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_server_cert_private_key_container() -> str: ...
ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)
Default Value
""
Remarks
This is the name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_server_cert_public_key Property
This is the public key of the certificate.
Syntax
def get_ssl_server_cert_public_key() -> str: ...
ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_server_cert_public_key_algorithm Property
This property contains the textual description of the certificate's public key algorithm.
Syntax
def get_ssl_server_cert_public_key_algorithm() -> str: ...
ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_public_key_length Property
This is the length of the certificate's public key (in bits).
Syntax
def get_ssl_server_cert_public_key_length() -> int: ...
ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_server_cert_serial_number Property
This is the serial number of the certificate encoded as a string.
Syntax
def get_ssl_server_cert_serial_number() -> str: ...
ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_server_cert_signature_algorithm Property
The property contains the text description of the certificate's signature algorithm.
Syntax
def get_ssl_server_cert_signature_algorithm() -> str: ...
ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_server_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_server_cert_store() -> bytes: ...
ssl_server_cert_store = property(get_ssl_server_cert_store, None)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password protected, specify the password in ssl_server_cert_store_password.
ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
This property is read-only.
ssl_server_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_server_cert_store_password() -> str: ...
ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)
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.
This property is read-only.
ssl_server_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_server_cert_store_type() -> int: ...
ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
ssl_server_cert_subject_alt_names Property
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_server_cert_subject_alt_names() -> str: ...
ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_server_cert_thumbprint_md5 Property
This property contains the MD5 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_md5() -> str: ...
ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha1 Property
This property contains the SHA-1 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha1() -> str: ...
ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_thumbprint_sha256 Property
This property contains the SHA-256 hash of the certificate.
Syntax
def get_ssl_server_cert_thumbprint_sha256() -> str: ...
ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_server_cert_usage Property
This property contains the text description of UsageFlags .
Syntax
def get_ssl_server_cert_usage() -> str: ...
ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)
Default Value
""
Remarks
This property contains the text description of ssl_server_cert_usage_flags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_server_cert_usage_flags Property
This property contains the flags that show intended use for the certificate.
Syntax
def get_ssl_server_cert_usage_flags() -> int: ...
ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_server_cert_version Property
This property contains the certificate's version number.
Syntax
def get_ssl_server_cert_version() -> str: ...
ssl_server_cert_version = property(get_ssl_server_cert_version, None)
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_server_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_server_cert_subject() -> str: ...
ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
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
This property includes the 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.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
upload_session_id Property
The Id of the resumable upload session.
Syntax
def get_upload_session_id() -> str: ... def set_upload_session_id(value: str) -> None: ...
upload_session_id = property(get_upload_session_id, set_upload_session_id)
Default Value
""
Remarks
This property specifies the Id of the resumable upload session. This is populated by the class when use_resumable_upload is set to True and upload_file is called to initiate the upload.
This must be set when resuming an upload. See upload_file for details.
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.
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 query_params 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 o_auth property.
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_resource Method
Copies a resource.
Syntax
def copy_resource(from_resource: str, to_resource_path: str) -> str: ...
Remarks
This method copies the resource FromResource to a new path ToResourcePath, and returns the Id of the newly-copied resource.
FromResource must be a path, an Id-based relative path, or a resource Id. ToResourcePath must be a path or an Id-based relative path (it must always end with the desired name of the file/folder resource being copied).
The AllowCopySharedFolders configuration setting must be enabled before calling this method in order to copy shared resources.
The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.
create_folder Method
Creates a new folder resource.
Syntax
def create_folder(new_folder_path: str) -> str: ...
Remarks
This method creates a new folder resource at the path NewFolderPath, and returns the Id of the newly-created folder resource.
NewFolderPath must be a folder path, or an Id-based relative folder path.
The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.
create_link Method
Creates a shared link for a resource.
Syntax
def create_link(resource: str) -> str: ...
Remarks
This method creates a shared link for the resource specified by Resource and returns it.
Resource must be a path, an Id-based relative path, or a resource Id.
The CreateLinkExpiration, CreateLinkVisibility, and CreateLinkPassword configuration settings can be used to customize the settings used to create the shared link.
// Create a password-protected shared link for the given file.
dropbox.Config("CreateLinkPassword=password");
string sharingUrl = dropbox.CreateLink("/work_stuff/serious_business/best_cat_pictures.zip");
delete_resource Method
Deletes a resource.
Syntax
def delete_resource(resource: str) -> None: ...
Remarks
This method deletes the resource specified by Resource.
Resource must be a path, an Id-based relative path, or a resource Id.
When deleting file resources, the IfRevision configuration setting can be set to a revision Id before calling this method. This will ensure that the server only deletes the file resource if its latest revision Id matches the one provided.
For Dropbox Business accounts, the PermanentlyDelete configuration setting can be enabled to delete resources permanently.
download_file Method
Downloads a file resource.
Syntax
def download_file(resource: str) -> None: ...
Remarks
This method downloads the file resource specified by Resource. If the AllowFolderDownloads configuration setting is enabled, it can also be used to download a folder resource as a ZIP file.
Resource must be a path, an Id-based relative path, a resource Id, or (for file resources only) a revision Id.
For file resources, the download_type property can be used to control whether this method downloads the file contents (default), a file preview, or a file thumbnail. The latter two options are only available for certain file types; refer to download_type for more information.
Note that certain file resources are "export-only"; when downloading such a file resource to a local_file, the class will append the file extension of export file format (if the name of the given local_file does not already end with said extension). Refer to the resource_export_extension property for more information.
If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.
To download and decrypt an encrypted file, set encryption_algorithm and encryption_password before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
dropbox.LocalFile = "../MyFile.zip";
dropbox.DownloadFile(dropbox.Resources[0].Id);
Resuming Downloads
The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
dropbox.LocalFile = downloadFile;
dropbox.DownloadFile(dropbox.Resources[0].Id);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
dropbox.StartByte = new FileInfo(downloadFile).Length;
dropbox.DownloadFile(dropbox.Resources[0].Id);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.
If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file.
dropbox.LocalFile = "../MyFile.zip";
dropbox.EncryptionPassword = "password";
dropbox.DownloadFile(dropbox.Resources[0].Id);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
dropbox.StartByte = new FileInfo(dropbox.Config("DownloadTempFile")).Length;
dropbox.DownloadFile(dropbox.Resources[0].Id);
get_account_info Method
Gets information about the current user's account and space usage.
Syntax
def get_account_info() -> None: ...
Remarks
This method gets information about the current user's account and space usage, populating the account object property's properties. This method will also populate the following configuration settings, if necessary:
get_current_change_marker Method
Gets the most current change marker.
Syntax
def get_current_change_marker(folder_resource: str) -> None: ...
Remarks
This method populates next_change_marker with the most current change marker available. Like list_changes, it may be limited to only changes within a certain FolderResource; and is sensitive to the IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings.
FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder).
Refer to list_changes for more information.
get_resource_info Method
Gets information about a specific resource.
Syntax
def get_resource_info(resource: str) -> None: ...
Remarks
This method gets information about the resource specified by Resource.
Resource must be a path, an Id-based relative path, a resource Id, or (for file resources) a revision Id. Empty string (the root folder) is not supported.
Calling this method will fire the on_resource_list event, and will populate the resources properties with a single item (clearing any previously-held items in the process).
interrupt Method
This method interrupts the current method.
Syntax
def interrupt() -> None: ...
Remarks
If there is no method in progress, interrupt simply returns, doing nothing.
list_changes Method
Lists changes to resources.
Syntax
def list_changes(folder_resource: str) -> None: ...
Remarks
This method lists changes to resources within the specified FolderResource.
FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder). The IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings may be used to further control the scope of the results.
Note that the values of FolderResource and the aforementioned configuration settings are all ignored if either change_marker or next_change_marker is populated (the markers encode the values used originally).
Starting from a Baseline State
For most use-cases, it is necessary to obtain a baseline state first in order to have a context onto which later changes can be applied.
To obtain a baseline state, ensure that both change_marker and next_change_marker are empty, and then call list_changes. Then follow the process described in the "General Usage" section (below) until change_marker is empty, keeping in mind that the results being returned are not necessarily* changes, but rather the current state of resources within the scope determined by FolderResource, IncludeDeleted, IncludeMounted, and RecurseSubfolders.
*If any resources in the aforementioned scope are changed before all result pages of the baseline have been returned, Dropbox may append those change items to the end of the baseline's results. Refer to the "Usage Considerations" section (below) for more information.
Starting from the Latest State
For use-cases that don't require a baseline state (e.g., perhaps an application just displays a "ticker" with change information), call get_current_change_marker. This will populate next_change_marker immediately.
General Usage
When this method is called, it will use the change marker stored in either change_marker or next_change_marker (only one can be populated at a time) to request the next page of changes. This method causes the on_resource_list event to fire once for each change, and will also populate the resources properties.
If there are still more changes available to list when this method returns, the change_marker property will be populated. Continue to call this method until change_marker is empty to accumulate all pages of results in the resources properties. (Once there aren't any more changes available to list, the next_change_marker property will be populated instead.)
When next_change_marker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling list_changes immediately after next_change_marker is populated will not return any further changes.)
Example of Getting a Baseline and then Listing Changes
// Get the baseline state first.
Dropbox dropbox = new Dropbox();
dropbox.ListChanges("");
do {
// Continue to call ListChanges() until ChangeMarker is the empty string (indicating there
// are no more changes to list).
dropbox.ListChanges("");
} while (dropbox.ChangeMarker.Length > 0);
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Apply the baseline state.
}
// Now NextChangeMarker will be populated. If we were to call ListChanges() again right now,
// nothing would be listed and NextChangeMarker would still be populated.
// Wait at least 2 minutes for changes to occur. Assume something changes while we wait.
dropbox.WaitForChanges(120); // (Note that this is a blocking call.)
dropbox.ListChanges("");
do {
dropbox.ListChanges("");
} while (dropbox.ChangeMarker.Length > 0);
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Apply the changes.
}
Usage Considerations
When working with Dropbox changes, keep in mind that it is possible for a resource, uniquely identified by its Id, to appear more than once in a change set. (This can happen if changes are being listed, and then a change occurs before all result pages in the change set are returned; Dropbox will then typically append the new change to the end of the current change set.) Since a Dropbox change always reflects the latest state of a resource, just use the latest one.list_resources Method
Lists resources.
Syntax
def list_resources(folder_resource: str) -> None: ...
Remarks
This method lists resources within the specified FolderResource.
FolderResource must be a folder path, an Id-based relative folder path, a folder resource Id, or empty string (the root folder). The IncludeDeleted, IncludeMounted, MaxResults, and RecurseSubfolders configuration settings may be used to further control the scope of the results.
Note that the values of FolderResource and the aforementioned configuration settings are all ignored if resource_marker is populated (the marker encodes the values used originally).
Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.
If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the resources properties.
// ResourceList event handler.
dropbox.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
do {
dropbox.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(dropbox.ResourceMarker));
list_revisions Method
Lists revisions for a file path or file resource Id.
Syntax
def list_revisions(file_resource: str) -> None: ...
Remarks
This method lists revisions for a specific file path or for a specific file resource Id. This method is not supported for folder resources.
FileResource must be a file path, an Id-based relative file path, or a file resource Id.
Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.
The MaxRevisionResults configuration setting controls the maximum number of results returned. (Note that unlike the class's other listing methods, the results returned by this method are never paged; MaxRevisionResults specifies the overall limit rather than the page size limit.)
Path-based vs. Id-based Revision Histories
When listing revisions, the server can return the revision history either by path or by Id. A path's revision history will include revisions for any and all files that have been located there; while an Id's revision history will only return revisions for the associated file resource (regardless of where it's been located over time).
By default, the class chooses which mode the server should use automatically each time list_revisions is called based on the kind of resource identifier passed for the FileResource parameter. If a path (or an Id-based relative path) is provided, it chooses the path-based mode; and if a file resource Id is provided, it chooses the Id-based mode.
The ListRevisionsMode configuration setting can be used to explicitly control which revision listing mode the server should use.
// ResourceList event handler.
dropbox.OnResourceList += (s, e) => {
Console.WriteLine(e.Name + ", Revision: " + e.Revision);
};
dropbox.ListRevisions("/work_stuff/serious_business/best_cat_pictures.zip");
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Process resource revisions here.
}
list_shared_links Method
Lists shared links created by the current user.
Syntax
def list_shared_links(resource: str) -> None: ...
Remarks
This method lists shared links created by the current user. If Resource is empty string, all of the user's shared links will be returned. If Resource is non-empty, the results will be limited to just shared links that provide access to the resource in question (direct links and links to any parent folders).
Resource must be a path, an Id-based relative path, a resource Id, or empty string.
Calling this method will fire the on_shared_link_list event once for each shared link, and will also populate the shared_links properties.
If there are still more shared links available to list when this method returns, the shared_link_marker property will be populated. Continue to call this method until shared_link_marker is empty to accumulate all pages of results in the shared_links properties.
// SharedLinkList event handler.
dropbox.OnSharedLinkList += (s, e) => {
Console.WriteLine(e.Name + ", URL: " + e.URL);
};
// List all of the shared links created by the current user.
do {
dropbox.ListSharedLinks("");
for (int i = 0; i < dropbox.SharedLinks.Count; i++) {
// Process shared links here.
}
} while (!string.IsNullOrEmpty(dropbox.SharedLinkMarker));
move_resource Method
Moves a resource.
Syntax
def move_resource(from_resource: str, to_resource_path: str) -> None: ...
Remarks
This method moves the resource FromResource to a new path ToResourcePath.
FromResource must be a path, an Id-based relative path, or a resource Id. ToResourcePath must be a path or an Id-based relative path (it must always end with the name of the file/folder resource being moved).
The AllowOwnershipTransfers configuration setting must be enabled before calling this method if a move operation would result in the current user transferring their ownership to another user (or to a team).
The RenameIfExists configuration setting may be enabled before calling this method to have the server automatically resolve naming conflicts.
reset Method
Resets the class to its initial state.
Syntax
def reset() -> None: ...
Remarks
This method resets the class to its initial state.
restore_resource Method
Restores a given file resource revision.
Syntax
def restore_resource(revision: str, to_resource_path: str) -> str: ...
Remarks
This method restores a the specified Revision of a file resource, saving it to the given path ToResourcePath. Restoring a deleted file resource can also be done using this method as long as the revision Id is known (there's no way to obtain revision Ids for file resources which have already been deleted; this is a limitation of the Dropbox API).
Revision must be a revision Id. ToResourcePath must be a file path (and it must end with the desired name of the file resource being restored).
revoke_link Method
Revokes a shared link.
Syntax
def revoke_link(shared_link: str) -> None: ...
Remarks
This method revokes an existing shared link; SharedLink must be a shared link URL.
Keep in mind that a resource may still be accessible after revoking its shared link if shared links still exist for any of its parent folders. The list_shared_links method can be used to get a list of all existing links that provide access to any given resource.
search Method
Searches for resources.
Syntax
def search(folder_resource: str, query: str) -> None: ...
Remarks
This method searches for resources matching Query within the specified FolderResource.
FolderResource must be a folder path, an Id-based, relative folder path, a folder resource Id, or empty string (in which case the current user's entire Dropbox is searched). The search_categories, search_file_extensions, search_kind, and search_names_only properties may be used to further control the search options the server uses.
Calling this method will fire the on_resource_list event once for each search result, and will also populate the resources properties.
If there are still more search results available to list when this method returns, the search_marker property will be populated. Continue to call this method until search_marker is empty to accumulate all pages of results in the resources properties.
The MaxSearchResults configuration setting can be used to control how many results are returned each time this method is called.
send_custom_request Method
Sends a custom request to the Dropbox 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 Dropbox API.
Valid values for HttpMethod are:
- GET
- POST (default if empty)
The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Dropbox API. The RequestBody parameter may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, as follows:
- The specified RequestPath is appended to the Dropbox API endpoint, https://api.dropboxapi.com/2.
- All query parameters in the query_params properties are added to the request URL.
- Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by authorization and other_headers, and the given RequestBody (if non-empty).
- Stores the response headers in the parsed_headers properties, and the response body in the specified local_file, or resource_data (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.
upload_file Method
Uploads a file resource.
Syntax
def upload_file(new_file_resource: str) -> str: ...
Remarks
This method uploads a new file resource (or potentially updates or overwrites an existing one). The Id of the newly-created (or updated) file resource is returned.
NewFileResource must be a file path, an Id-based relative file path, or (only when updating/overwriting) a file resource Id.
Name Conflict Resolution
The class automatically chooses how the server should resolve name conflicts (which occur if the specified NewFileResource already exists) based on the current values of the IfRevision and RenameIfExists configuration settings and the overwrite property. The following steps describe how the choice is made:
- If the uploaded file data is identical to the contents of the existing file resource, the server will always ignore the upload attempt and return a successful response, regardless of what IfRevision, RenameIfExists, and overwrite are currently set to. (This is a Dropbox server-side behavior that cannot be changed.)
- Otherwise, if IfRevision is populated, then the existing file resource will have its contents updated as long as its latest revision Id matches the one held by IfRevision. If the revision Ids don't match, then RenameIfExists decides the outcome:
- If RenameIfExists is True, then a new file resource is created with a unique name that contains "conflicted copy".
- If RenameIfExists is False, then the upload fails.
- Otherwise, if RenameIfExists is True, then a new file resource is created with a unique name.
- Otherwise, if overwrite is True, then the existing file resource is overwritten with a new one.
- Otherwise, the upload fails.
If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.
To encrypt the file before uploading it, set encryption_algorithm and encryption_password.
Upload Notes
Dropbox 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.
dropbox.LocalFile = "../MyFile.zip";
dropbox.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. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.
When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. upload_session_id is populated with a resumable upload session Id identifying the session (this value may be needed for additional operations if the upload does not complete normally).
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 upload_session_id 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.
dropbox.LocalFile = "../MyFile.zip";
dropbox.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.
dropbox.UploadFile("MyFile.zip");
wait_for_changes Method
Waits a certain amount of time for changes to occur.
Syntax
def wait_for_changes(timeout: int) -> bool: ...
Remarks
This method blocks for Timeout seconds, waiting for changes to occur within the scope represented by the current next_change_marker (which must already be populated). If any changes occur, returns True; otherwise returns False.
Timeout must be a value between 30 and 480 seconds (inclusive). Note that Dropbox also adds 90 seconds of random jitter to this value. This method may return early if changes occur before the total timeout expires.
If this method returns True, use list_changes to retrieve the changes.
Note that this method will automatically change the value of timeout property as necessary when called; and will restore the original value before returning.
// Get the baseline state first.
Dropbox dropbox = new Dropbox();
dropbox.ListChanges("");
do {
// Continue to call ListChanges() until ChangeMarker is the empty string (indicating there
// are no more changes to list).
dropbox.ListChanges("");
} while (dropbox.ChangeMarker.Length > 0);
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Apply the baseline state.
}
// Now NextChangeMarker will be populated. If we were to call ListChanges() again right now,
// nothing would be listed and NextChangeMarker would still be populated.
// Wait at least 2 minutes for changes to occur. Assume something changes while we wait.
dropbox.WaitForChanges(120); // (Note that this is a blocking call.)
dropbox.ListChanges("");
do {
dropbox.ListChanges("");
} while (dropbox.ChangeMarker.Length > 0);
for (int i = 0; i < dropbox.Resources.Count; i++) {
// Apply the changes.
}
on_end_transfer Event
This event fires when a document finishes transferring.
Syntax
class DropboxEndTransferEventParams(object): @property def direction() -> int: ... # In class Dropbox: @property def on_end_transfer() -> Callable[[DropboxEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[DropboxEndTransferEventParams], 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
Fired when information is available about errors during data delivery.
Syntax
class DropboxErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class Dropbox: @property def on_error() -> Callable[[DropboxErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[DropboxErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_fragment_complete Event
Fires after each fragment of a resumable upload is completed.
Syntax
class DropboxFragmentCompleteEventParams(object): @property def fragment_number() -> int: ... @property def fragment_count() -> int: ... @property def interrupt() -> bool: ... @interrupt.setter def interrupt(value) -> None: ... # In class Dropbox: @property def on_fragment_complete() -> Callable[[DropboxFragmentCompleteEventParams], None]: ... @on_fragment_complete.setter def on_fragment_complete(event_hook: Callable[[DropboxFragmentCompleteEventParams], 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 DropboxHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class Dropbox: @property def on_header() -> Callable[[DropboxHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[DropboxHeaderEventParams], 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_log Event
This event fires once for each log message.
Syntax
class DropboxLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class Dropbox: @property def on_log() -> Callable[[DropboxLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[DropboxLogEventParams], 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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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_progress Event
Fires during an upload or download to indicate transfer progress.
Syntax
class DropboxProgressEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def total_bytes() -> int: ... @property def percent_done() -> int: ... # In class Dropbox: @property def on_progress() -> Callable[[DropboxProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[DropboxProgressEventParams], 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_resource_list Event
Fires once for each resource returned when listing resources, changes, or revisions.
Syntax
class DropboxResourceListEventParams(object): @property def id() -> str: ... @property def name() -> str: ... @property def path() -> str: ... @property def resource_type() -> int: ... @property def modified_time() -> str: ... @property def size() -> int: ... @property def access_type() -> int: ... @property def revision() -> str: ... @property def hash() -> str: ... @property def deleted() -> bool: ... # In class Dropbox: @property def on_resource_list() -> Callable[[DropboxResourceListEventParams], None]: ... @on_resource_list.setter def on_resource_list(event_hook: Callable[[DropboxResourceListEventParams], None]) -> None: ...
Remarks
This event fires once for each resource returned when list_resources, get_resource_info, search, list_changes, or list_revisions is called.
Id is the Id of the resource.
Name is the name of the resource.
Path is the path of the resource.
ResourceType reflects the resource's type. Possible values are:
0 (drtFile) | A file. |
1 (drtFolder) | A folder. |
ModifiedTime reflects the last modified time of the file resource, as reported by the server. Not applicable for folder resources. Timestamps are formatted according to ISO 8601 and are always in UTC time.
Size is the size of the file resource, in bytes. Not applicable for folder resources.
AccessType reflects the type of access the current user has to the resource. Possible values are:
0 (atUnrestricted) | The user's access to the resource is not restricted. |
1 (atReadOnly) | The user has read-only access to the resource. This indicates that the resource is, or is located within, a read-only shared folder. |
2 (atLimited) | The user has limited access to the immediate contents of the folder resource (by virtue of having access to one or more other resources located somewhere within the folder). See further notes below. Only applicable to folders. |
3 (atNoAccess) | The user is allowed to see that the folder resource exists, but may not access its contents. Only applicable to folders. |
An access type of 2 (atLimited) still allows the user to call list_resources for a folder, but the results will be limited to the subset of resources within that folder that the user can actually access (including any further limited-access subfolders).
Revision is the revision Id of the file resource. Note applicable for folder resources.
Hash holds a hash of the file resource's content. Not applicable for folder resources.
Deleted indicates whether the resource has been deleted.
on_shared_link_list Event
Fires once for each shared link returned when listing shared links.
Syntax
class DropboxSharedLinkListEventParams(object): @property def url() -> str: ... @property def name() -> str: ... @property def id() -> str: ... @property def path() -> str: ... @property def resource_type() -> int: ... @property def visibility() -> int: ... @property def expires() -> str: ... # In class Dropbox: @property def on_shared_link_list() -> Callable[[DropboxSharedLinkListEventParams], None]: ... @on_shared_link_list.setter def on_shared_link_list(event_hook: Callable[[DropboxSharedLinkListEventParams], None]) -> None: ...
Remarks
This event fires once for each shared link returned when list_shared_links is called.
URL is the URL of the shared link.
Name is the name of the linked resource.
Id is Id of the linked resource.
Path is the path of the linked resource.
ResourceType reflects the linked resource's type. Possible values are:
0 (lrtFile) | A file. |
1 (lrtFolder) | A folder. |
Visibility reflects the visibility of the link. Possible values are:
0 (lvPublic) | Anyone with the link can access the linked resource. |
1 (lvTeamOnly) | Only members of the same team with the link can access the linked resource. (Only applicable to Dropbox Business.) |
2 (lvPassword) | Anyone with the link and the link's password can access the linked resource. |
3 (lvTeamAndPassword) | Only members of the same team with the link and the link's password can access the linked resource. (Only applicable to Dropbox Business.) |
4 (lvSharedFolderOnly) | Only members (with the link) of the shared folder containing the linked resource can access it. |
Expires is the expiration timestamp of the link (or empty string, if the link doesn't expire). Timestamps are formatted according to ISO 8601 and are always in UTC time.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class DropboxSSLServerAuthenticationEventParams(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 Dropbox: @property def on_ssl_server_authentication() -> Callable[[DropboxSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[DropboxSSLServerAuthenticationEventParams], None]) -> None: ...
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
on_ssl_status Event
Fired when secure connection progress messages are available.
Syntax
class DropboxSSLStatusEventParams(object): @property def message() -> str: ... # In class Dropbox: @property def on_ssl_status() -> Callable[[DropboxSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[DropboxSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
on_start_transfer Event
This event fires when a document starts transferring (after the headers).
Syntax
class DropboxStartTransferEventParams(object): @property def direction() -> int: ... # In class Dropbox: @property def on_start_transfer() -> Callable[[DropboxStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[DropboxStartTransferEventParams], 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 DropboxTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class Dropbox: @property def on_transfer() -> Callable[[DropboxTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[DropboxTransferEventParams], 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.
Dropbox Config Settings
The class accepts one or more of the following configuration settings. Configuration 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.Dropbox Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
This setting is disabled by default.
This setting is disabled by default.
This setting is disabled by default.
Timestamps are formatted according to ISO 8601 and are always in UTC time.
Timestamps are formatted according to ISO 8601 and are always in UTC time.
0 (default) | Public | Anyone with the link can access the linked resource. |
1 | Team only | Only members of the same team with the link can access the linked resource. (Only applicable to Dropbox Business.) |
2 | Password | Anyone with the link and the link's password can access the linked resource. |
Note that links created for team resources are subject to the team's access policies, and thus may end up with a different visibility than was requested.
yyyy | year |
MM | month |
dd | day |
hh | hours |
mm | minutes |
ss | seconds |
fff | milliseconds |
These format specifiers can be written in any combination. For example:
DropBox.Config("DateFormat=yyyy-MM-ddThh:mm:ss");
DropBox.Config("DateFormat=dd/MM/yyyy hh:mm:ss");
If this setting is not specified, the default date/time format will be yyyy-MM-ddTHH:mm:ssZ. This is from ISO 8601.
When downloading encrypted data with local_file set, the class will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to local_file.
If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See download_file for details.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
The default value is 10485760 (10MB).
- delete_resource: Prevents the deletion from occurring if the specified revision Id does not match the latest revision Id of the file resource specified by the Resource method parameter. (Not supported when deleting folder resources.)
- upload_file: Refer to the upload_file method's documentation for information.
Note that Dropbox only returns a very limited subset of metadata for deleted resources; this is a limitation of the Dropbox API that cannot be changed. Specifically, the following properties are returned:
- resource_deleted (always True)
- resource_name
- resource_path
This setting is disabled by default.
This setting is enabled by default.
By default, the class chooses which mode the server should use automatically each time list_revisions is called based on the kind of resource identifier passed for the FileResource parameter. If a path (or an Id-based relative path) is provided, it chooses the path-based mode; and if a file resource Id is provided, it chooses the Id-based mode.
This setting can be used to explicitly control which revision listing mode the server should use. Possible values are:
0 (default) | Auto | The class will automatically choose which mode the server uses based on the kind of resource identifier passed to list_revisions. |
1 | Path | The server will always list revisions by path. If a file resource Id is passed to list_revisions, the server will use the path of the file associated with that Id. |
2 | Id | The server will always list revisions by file resource Id. If a path (or an Id-based relative path) is provided, the server will use the Id of the file at that path. |
Acceptable values are from 1 to 2000 inclusive. The default is -1, which causes the server's default to be used.
Acceptable values are from 1 to 100 inclusive. The default is -1, which causes the server's default (10) to be used.
Acceptable values are from 1 to 1000 inclusive. The default is -1, which causes the server's default (100) to be used.
This setting is disabled by default; upload_file will cause the server to send file upload/update notifications.
This setting is disabled by default. Permanent deletion is only supported for Dropbox Business.
If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the on_progress event will account for the data that was successfully transferred before the interruption.
If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the on_progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the on_progress event for more information.
The default value, 1, will cause the on_progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the on_progress event to fire every time data is transferred.
Note that the on_progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were 0 for the duration of the transfer.
This setting is disabled by default.
The name the server choses will be always unique; it will append a number to the end of the original name (for files, before the extension). That number will be incremented until a unique name is found.
This setting is disabled by default. Note that, when calling upload_file, this setting takes precedence over the overwrite property if both are enabled.
0 (default) | JPEG |
1 | PNG |
0 (default) | Strict | Scale down the image to fit within the given ThumbnailSize. |
1 | Best fit | Scale down the image to fit within the given ThumbnailSize or its transpose. |
2 | Best fit one | Scale down the image to completely cover the given ThumbnailSize or its transpose. |
0 | 32x32 px |
1 (default) | 64x64 px |
2 | 128x128 px |
3 | 256x256 px |
4 | 480x320 px |
5 | 640x480 px |
6 | 960x640 px |
7 | 1024x768 px |
8 | 2048x1536 px |
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by authorize will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. |
For example, when using the Authorization Code grant type, the o_auth_refresh_token property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction.
If set to True (default) the redirect_uri will be sent in all cases. If set to False the redirect_uri will only be sent if it has a value.
To parse the payload for specific claims, see OAuthJWTXPath.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D.
The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
Accessor | Description |
name | The first element with a particular name. Can be *. |
[i] | The i-th element. |
name[i] | The i-th element with a particular name. |
[last()] | The last element. |
[last()-i] | The element i before the last element. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see OAuthJWTXText.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the OAuthJWTXPath configuration setting. This configuration setting is read-only.
component.Config("OAuthParamCount=2");
component.Config("OAuthParamName[0]=myvar");
component.Config("OAuthParamValue[0]=myvalue");
component.Config("OAuthParamName[1]=testname");
component.Config("OAuthParamValue[1]=testvalue");
Additionally, this will also be updated to hold the parameters returned in the response.
for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++)
{
string name = component.Config("OAuthParamName[" + i + "]");
string value = component.Config("OAuthParamValue[" + i + "]");
}
- 1 (Plain)
- 2 (S256/SHA256 - default)
.NET
Gmail gmail = new Gmail();
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
Console.WriteLine(gmail.Config("OAuthTransferredRequest"));
C++
Gmail gmail;
gmail.Config("OAuthTransferredRequest=on");
gmail.Authorize();
printf("%s\r\n", gmail.Config("OAuthTransferredRequest"));
This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when authorize is called. In certain cases, it is required to start the webserver before calling authorize. For example, if the o_auth_return_url needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the OAuthReUseWebServer is set to true, the server will not be automatically stopped, and this configuration setting must be set to "false" to stop the embedded web server.
The OAuthWebServerCertStoreType property specifies the type of the certificate store specified by OAuthWebServerCertStore. If the store is password protected, specify the password in OAuthWebServerCertStorePassword.
OAuthWebServerCertStore is used in conjunction with the OAuthWebServerCertSubject property in order to specify the certificate to be used during SSL.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
Note: This is required when OAuthWebServerSSLEnabled is set to True.
Note: This is only applicable when OAuthWebServerSSLEnabled is set to True.
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when OAuthWebServerSSLEnabled is set to True.
The default value is localhost.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is False.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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).
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed 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 setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.
If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Dropbox Errors
Common Errors
600 | A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information. |
601 | An unsupported operation or action was attempted. |
602 | The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON. |
603 | The login credentials specified were invalid. Please refer to the error message for more information. |
604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. |
605 | An invalid index was specified. |
606 | An upload was aborted by the user before it could finish. |
607 | The specified resource is a folder and cannot be downloaded. |
608 | A download failed because the specified local_file already exists and overwrite is False. |
609 | The class could not resume a download or upload. Please refer to the error message for more information. |
610 | An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set. |
611 | An exception occurred while working with the specified local_file (or the current value of local_file is invalid). Please refer to the error message for more information. |
612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 | Firewall Error. Error description contains detailed message. |
143 | Busy executing current method. |
151 | HTTP protocol error. The error message has the server response. |
152 | No server specified in url |
153 | Specified url_scheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
SSL Errors
270 | Cannot load specified security library. |
271 | Cannot open certificate store. |
272 | Cannot find specified certificate. |
273 | Cannot acquire security credentials. |
274 | Cannot find certificate chain. |
275 | Cannot verify certificate chain. |
276 | Error during handshake. |
280 | Error verifying certificate. |
281 | Could not find client certificate. |
282 | Could not find server certificate. |
283 | Error encrypting data. |
284 | Error decrypting data. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |