WebDAVClient Class
Properties Methods Events Configuration Settings Errors
The WebDAVClient class provides client-side functionality of the WebDAV protocol.
Syntax
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 class with short descriptions. Click on the links for further details.
BaseURL | The base URL. |
ClientCertCount | The number of records in the ClientCert arrays. |
ClientCertBytes | Returns raw certificate data in DER format. |
ClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Connected | Indicates whether the connection is active. |
ConnInfoAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
ConnInfoChainValidationDetails | The details of a certificate chain validation outcome. |
ConnInfoChainValidationResult | The outcome of a certificate chain validation routine. |
ConnInfoCiphersuite | The cipher suite employed by this connection. |
ConnInfoClientAuthenticated | Specifies whether client authentication was performed during this connection. |
ConnInfoClientAuthRequested | Specifies whether client authentication was requested during this connection. |
ConnInfoConnectionEstablished | Indicates whether the connection has been established fully. |
ConnInfoConnectionID | The unique identifier assigned to this connection. |
ConnInfoDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
ConnInfoEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
ConnInfoExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
ConnInfoKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
ConnInfoKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
ConnInfoNamedECCurve | The elliptic curve used in this connection. |
ConnInfoPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
ConnInfoPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
ConnInfoPublicKeyBits | The length of the public key. |
ConnInfoResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
ConnInfoSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
ConnInfoServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
ConnInfoSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
ConnInfoSymmetricBlockSize | The block size of the symmetric algorithm used. |
ConnInfoSymmetricKeyBits | The key length of the symmetric algorithm used. |
ConnInfoTotalBytesReceived | The total number of bytes received over this connection. |
ConnInfoTotalBytesSent | The total number of bytes sent over this connection. |
ConnInfoValidationLog | Contains the server certificate's chain validation log. |
ConnInfoVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
CurrListEntryATime | Contains the last access time for this object, in UTC. |
CurrListEntryContentType | The object's content type. |
CurrListEntryCTime | Contains this object's creation time, in UTC. |
CurrListEntryDirectory | Specifies whether this object is a directory. |
CurrListEntryDisplayName | Contains the display name of the object. |
CurrListEntryETag | An e-tag of the object. |
CurrListEntryFullURL | A full path to the object. |
CurrListEntryMTime | The last modification time of the object, in UTC. |
CurrListEntryParentURL | Specifies the object's parent URL. |
CurrListEntrySize | The size of the object in bytes. |
CurrListEntrySupportsExclusiveLock | Indicates whether the entry supports exclusive locking. |
CurrListEntrySupportsSharedLock | Indicates whether the entry supports shared lock. |
CurrListEntryURL | A URL of the object. |
CurrentLocks | The list of current object locks. |
EncodeURL | Enables or disables URL encoding. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
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. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
ResourceOwner | Indicates the resource owner. |
ServerCertCount | The number of records in the ServerCert arrays. |
ServerCertBytes | Returns raw certificate data in DER format. |
ServerCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
ServerCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
ServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ServerCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
ServerCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
ServerCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
ServerCertKeyBits | Returns the length of the public key. |
ServerCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
ServerCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
ServerCertPublicKeyBytes | Contains the certificate's public key in DER format. |
ServerCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
ServerCertSerialNumber | Returns the certificate's serial number. |
ServerCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
ServerCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
ServerCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
ServerCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
ServerCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
ServerCertValidTo | The time point at which the certificate expires, in UTC. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
Username | A username to authenticate to the server. |
Method List
The following is the full list of the methods of the class 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 class 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 class 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. |