WebDAVClient Component
Properties Methods Events Configuration Settings Errors
The WebDAVClient component provides client-side functionality of the WebDAV protocol.
Syntax
nsoftware.SecureBlackboxLite.Webdavclient
Remarks
WebDAVClient is capable of making requests to DAV servers via TLS-enabled or plain TCP channels. It supports most of file operations offered by WebDAV servers, such as downloads, uploads, and file system operations.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
BaseURL | The base URL. |
ClientChain | The TLS client certificate chain. |
Connected | Indicates whether the connection is active. |
ConnectionInfo | Returns the details of the underlying network connection. |
CurrentListEntry | Populates the details of a list entry. |
CurrentLocks | The list of current object locks. |
EncodeURL | Enables or disables URL encoding. |
ExternalCrypto | Provides access to external signing and DC parameters. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
LockDepth | Specifies the depth of the current lock. |
LockScope | Specifies the scope of the current lock. |
LockTimeout | Specifies the timeout of the current lock. |
MoveToRename | Enables move-to-rename operation handling mode. |
OverwriteOnCopy | Enables overwriting on copy. |
OverwriteOnMove | Enables overwriting on move. |
Password | A password to authenticate to the server. |
Proxy | The proxy server settings. |
ResourceOwner | Indicates the resource owner. |
ServerChain | The TLS server's certificate chain. |
SocketSettings | Manages network connection settings. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
Username | A username to authenticate to the server. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Connect | Establishes connection to a WebDAV server. |
Copy | Copies a remote file. |
CustomRequest | Performs custom WebDAV request. |
DeleteDir | Removes a remote directory. |
DeleteFile | Deletes a remote file. |
DirExists | Checks if a directory exists on the server. |
Disconnect | Disconnects from the server. |
DownloadFile | Downloads a file from the server. |
DownloadStream | Downloads a file from the server. |
FileExists | Checks if a file exists on the server. |
GetFileSize | Requests the size of a remote file. |
ListDir | Lists the remote directory contents. |
ListDirRecursive | Lists the remote directory contents, recursively. |
Lock | Sets up a lock on a URL. |
MakeDir | Creates a directory on the server. |
MoveFile | Moves an object. |
RefreshLock | Refreshes an object lock. |
Rename | Renames an object. |
Unlock | Removes a lock from a URL. |
UploadFile | Uploads a file to the server. |
UploadStream | Uploads a stream to the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
CertificateValidate | Fires when the server's TLS certificate has to be validated. |
Error | Information about connection and request errors. |
ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
ListEntry | Passes the next directory listing entry to the application. |
Notification | This event notifies the application about an underlying control flow event. |
OperationError | Reports a protocol error. |
Progress | Fires periodically during the data transfer. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
ErrorOrigin | Specifies where the error has been originated. |
ErrorSeverity | Error severity. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
MoveToRename | Use MOVE operation to rename objects. |
OverwriteOnCopy | Overwrite any existing target objects during COPY. |
OverwriteOnMove | Overwrite any existing target objects during MOVE. |
TempPath | Path for storing temporary files. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseOptionsForExistenceCheck | Use OPTIONS request to query the server for object existence. |
UseSystemCertificates | Enables or disables the use of the system certificates. |