WebDAV Module

Properties   Methods   Events   Config Settings   Errors  

The WebDAV Module implements an easy-to-use interface to the Web Distributed Authoring and Versioning (WebDAV) protocol.

Syntax

IPWorksSSL.WebDAV

Remarks

The WebDAV Class is designed to interact with the Web Distributed Authoring and Versioning (WebDAV) protocol. This class offers robust support for both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

Remote Resource Management

The WebDAV Class enables remote management of resource properties and collections, offering a comprehensive set of operations including creation, deletion, listing, copying, moving, and resource locking.

Listing Directories

The ListDirectory method is used to list the resources from a specific URI. Depending on the Depth property (see below) the scope of the list changes. For each resource found, the class fires the DirList once and also populates the Resource* properties.

Downloading Resources

The GetResource method is used to retrieve the data of a resource from a WebDAV server. The data is stored in the file from the LocalFile property or the TransferredData property respectively.

Uploading Resources

The PutResource method is used to send data to the WebDAV server using the PUT method to the specified resource URI. The data is taken from the the file from the LocalFile property.

Finding Properties

The FindProperties method is used to find the properties of a specific resource (or multiple resource depending on the Depth property). This search can be filtered by adding items to the Property* properties, one item for each property. This method will populate then populate the Property* properties (clearing the collection) and fire the ResourceProperties event once for each found property.

Depth

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

Namespaces

The namespaces are provided in the Namespace* properties, which is filled automatically when retrieving DAV responses, but must be filled manually when requesting nonstandard properties.

Property List

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

Method List

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

Event List

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

Config Settings

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

Accept Property (WebDAV Module)

This property includes a list of acceptable MIME types for the request.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accept,setter=setAccept:) NSString* accept;

- (NSString*)accept;
- (void)setAccept :(NSString*)newAccept;

Default Value

""

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Authorization Property (WebDAV Module)

This property includes the Authorization string to be sent to the server.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

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 AuthScheme 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]".

AuthScheme Property (WebDAV Module)

This property specifies the authentication scheme to use when server authentication is required.

Syntax

• Swift
• Objective-C

public var authScheme: WebDAVAuthSchemes {
  get {...}
  set {...}
}

public enum WebDAVAuthSchemes: Int32 {
  case authBasic = 0
  case authDigest = 1
  case authProprietary = 2
  case authNone = 3
  case authNtlm = 4
  case authNegotiate = 5
  case authOAuth = 6
}

@property (nonatomic,readwrite,assign,getter=authScheme,setter=setAuthScheme:) int authScheme;

- (int)authScheme;
- (void)setAuthScheme :(int)newAuthScheme;

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

Connected Property (WebDAV Module)

This property shows whether the module is connected.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)connected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only.

Cookies Property (WebDAV Module)

This property includes a collection of cookies.

Syntax

• Swift
• Objective-C

public var cookies: Array<HTTPCookie> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=cookieCount,setter=setCookieCount:) int cookieCount;

- (int)cookieCount;
- (void)setCookieCount :(int)newCookieCount;

- (NSString*)cookieDomain:(int)cookieIndex;

- (NSString*)cookieExpiration:(int)cookieIndex;

- (NSString*)cookieName:(int)cookieIndex;
- (void)setCookieName:(int)cookieIndex :(NSString*)newCookieName;

- (NSString*)cookiePath:(int)cookieIndex;

- (BOOL)cookieSecure:(int)cookieIndex;

- (NSString*)cookieValue:(int)cookieIndex;
- (void)setCookieValue:(int)cookieIndex :(NSString*)newCookieValue;

Default Value

""

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

Depth Property (WebDAV Module)

This property specifies the depth associated with the current operation.

Syntax

• Swift
• Objective-C

public var depth: WebDAVDepths {
  get {...}
  set {...}
}

public enum WebDAVDepths: Int32 {
  case dpUnspecified = 0
  case dpResourceOnly = 1
  case dpImmediateChildren = 2
  case dpInfinity = 3
}

@property (nonatomic,readwrite,assign,getter=depth,setter=setDepth:) int depth;

- (int)depth;
- (void)setDepth :(int)newDepth;

Default Value

0

Remarks

When performing certain operations on resource collections, the class will use Depth to instruct the server about how deep to operate within the collection. Depth is an enumerated type with the following possible values:

Depth is used when performing the following operations: LockResource, MoveResource CopyResource, FindProperties, PatchProperties, and ListDirectory.

Firewall Property (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

""

Remarks

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

FollowRedirects Property (WebDAV Module)

This property determines what happens when the server issues a redirect.

Syntax

• Swift
• Objective-C

public var followRedirects: WebDAVFollowRedirects {
  get {...}
  set {...}
}

public enum WebDAVFollowRedirects: Int32 {
  case frNever = 0
  case frAlways = 1
  case frSameScheme = 2
}

@property (nonatomic,readwrite,assign,getter=followRedirects,setter=setFollowRedirects:) int followRedirects;

- (int)followRedirects;
- (void)setFollowRedirects :(int)newFollowRedirects;

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class .

Note: Following the HTTP specification, unless this property is set to frAlways (1), 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. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class instead.

Idle Property (WebDAV Module)

This property specifies the current status of the module.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)idle;

Default Value

True

Remarks

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

This property is read-only.

LocalFile Property (WebDAV Module)

This property includes the path to a local file used for DAV operations.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

After a GetResource operation, LocalFile will contain the contents of the resource.

For a PutResource operation, LocalFile contains the data that will be uploaded to the server.

If LocalFile is empty, then the received data are provided through the Transfer event.

LocalHost Property (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In 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 LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

LockOwner Property (WebDAV Module)

This property specifies the principle that owns the current resource lock.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=lockOwner,setter=setLockOwner:) NSString* lockOwner;

- (NSString*)lockOwner;
- (void)setLockOwner :(NSString*)newLockOwner;

Default Value

""

Remarks

Before making a call to the LockResource method, LockOwner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockResource operation, the class will set the LockOwner property to the correct value returned in the server's response.

LockScope Property (WebDAV Module)

This property specifies the scope of the current resource lock.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=lockScope,setter=setLockScope:) NSString* lockScope;

- (NSString*)lockScope;
- (void)setLockScope :(NSString*)newLockScope;

Default Value

""

Remarks

Before making a call to the LockResource method, LockScope may be set to the type of scope needed for the lock. Currently, the class will allow only two types of scopes to be requested:

If no scope is specified, the protocol default scope, exclusive, will be requested. After a successful LockResource operation, the class will set the LockScope property to the correct value returned in the server's response.

LockTimeout Property (WebDAV Module)

This property includes the time to live for the current resource lock.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=lockTimeout,setter=setLockTimeout:) int lockTimeout;

- (int)lockTimeout;
- (void)setLockTimeout :(int)newLockTimeout;

Default Value

0

Remarks

Before a call to the LockResource method, LockTimeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If Timeout of 0 is specified, the server will use a default timeout. After a successful LockResource operation, the class will set the LockTimeout property to the correct value returned in the server's response.

LockTokens Property (WebDAV Module)

The lock string to be used when submitting operations on a locked resource.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=lockTokens,setter=setLockTokens:) NSString* lockTokens;

- (NSString*)lockTokens;
- (void)setLockTokens :(NSString*)newLockTokens;

Default Value

""

Remarks

Before a call to the LockResource method, LockTokens may be set to the tokens returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in LockTimeout. If the lock request is not a lock refresh, LockTokens must be empty, and they will be parsed out of the server response after a successful call to the LockResource method.

LockType Property (WebDAV Module)

This property specifies the type of the current resource lock.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=lockType,setter=setLockType:) NSString* lockType;

- (NSString*)lockType;
- (void)setLockType :(NSString*)newLockType;

Default Value

"write"

Remarks

Before making a call to the LockResource method, LockType may be set to the type of lock being requested. Currently, the class supports only requesting locks of type write, although the protocol defines an optional read lock. After a successful LockResource operation, the class will set the LockType property to the correct value returned in the server's response.

Namespaces Property (WebDAV Module)

This property includes the collection of namespaces in the current stack.

Syntax

• Swift
• Objective-C

public var namespaces: Array<XMLNamespace> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=namespaceCount,setter=setNamespaceCount:) int namespaceCount;

- (int)namespaceCount;
- (void)setNamespaceCount :(int)newNamespaceCount;

- (NSString*)namespacePrefix:(int)namespaceIndex;
- (void)setNamespacePrefix:(int)namespaceIndex :(NSString*)newNamespacePrefix;

- (NSString*)namespaceURI:(int)namespaceIndex;
- (void)setNamespaceURI:(int)namespaceIndex :(NSString*)newNamespaceURI;

Default Value

""

Remarks

WebDAV allows nonstandard properties to be specified through XML namespaces.

The collection is filled automatically when retrieving DAV responses, but it must be filled manually when requesting nonstandard properties.

If the DAV URI is not found in the namespaces collection, it will be added as the default namespace when generating a request. The DAV namespace URI is DAV:.

OtherHeaders Property (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by .

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

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

ParsedHeaders Property (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

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

- (int)parsedHeaderCount;

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

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

Default Value

""

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

Password Property (WebDAV Module)

This property includes a password if authentication is to be used.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Properties Property (WebDAV Module)

This property includes a collection of WebDAV properties.

Syntax

• Swift
• Objective-C

public var properties: Array<DAVProperty> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=propertyCount,setter=setPropertyCount:) int propertyCount;

- (int)propertyCount;
- (void)setPropertyCount :(int)newPropertyCount;

- (NSString*)propertyAttr:(int)propertyIndex;
- (void)setPropertyAttr:(int)propertyIndex :(NSString*)newPropertyAttr;

- (NSString*)propertyName:(int)propertyIndex;
- (void)setPropertyName:(int)propertyIndex :(NSString*)newPropertyName;

- (NSString*)propertyNamespaceURI:(int)propertyIndex;
- (void)setPropertyNamespaceURI:(int)propertyIndex :(NSString*)newPropertyNamespaceURI;

- (int)propertyOperation:(int)propertyIndex;
- (void)setPropertyOperation:(int)propertyIndex :(int)newPropertyOperation;

- (NSString*)propertyStatus:(int)propertyIndex;

- (NSString*)propertyValue:(int)propertyIndex;
- (void)setPropertyValue:(int)propertyIndex :(NSString*)newPropertyValue;

Default Value

""

Remarks

The property names provided in the Properties collection are used by the FindProperties and PatchProperties methods.

After a call to FindProperties, the Properties properties will contain the name, value, and status of the DAV property returned by the server. The contents of the properties change for every matching resource (ResourceProperties event). After the call completes, the properties will contain the values of the last matching resource.

When a call is made to PatchProperties, the class will use the operations provided in the Properties collection to tell the server what to do with the properties under the following scheme:

Proxy Property (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

Default Value

""

Remarks

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

Referer Property (WebDAV Module)

This property includes the referer URL/document (optional).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=referer,setter=setReferer:) NSString* referer;

- (NSString*)referer;
- (void)setReferer :(NSString*)newReferer;

Default Value

""

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

ResourceData Property (WebDAV Module)

Specifies the data to be uploaded to the webDAV server.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=resourceData,setter=setResourceData:) NSString* resourceData;

- (NSString*)resourceData;
- (void)setResourceData :(NSString*)newResourceData;

@property (nonatomic,readwrite,assign,getter=resourceDataB,setter=setResourceDataB:) NSData* resourceDataB;

- (NSData*)resourceDataB;
- (void)setResourceDataB :(NSData*)newResourceData;

Default Value

""

Remarks

This property specifies the data to be uploaded to the webDAV server. If neither the SetUploadStream nor LocalFile are specified, the data specified in this property will be uploaded to the designated resource when the PutResource method is called.

Resources Property (WebDAV Module)

This property includes a collection of resources resulting from the last directory listing.

Syntax

• Swift
• Objective-C

public var resources: Array<DAVResource> {
  get {...}
}

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

- (int)resourceCount;

- (NSString*)resourceContentLanguage:(int)resourceIndex;

- (long long)resourceContentLength:(int)resourceIndex;

- (NSString*)resourceContentType:(int)resourceIndex;

- (NSString*)resourceDisplayName:(int)resourceIndex;

- (NSString*)resourceLastModified:(int)resourceIndex;

- (NSString*)resourceURI:(int)resourceIndex;

Default Value

""

Remarks

This property contains a list of resources listed by the server after a call to the ListDirectory method. To retrieve properties of a particular resource, please refer to the FindProperties method.

MaxResources can be used to control the number of resource listings saved.

SSLAcceptServerCert Property (WebDAV Module)

This property instructs the module to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• Swift
• Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)SSLAcceptServerCertEffectiveDate;

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

- (NSString*)SSLAcceptServerCertExpirationDate;

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

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

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

- (NSString*)SSLAcceptServerCertFingerprint;

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

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

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

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

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

- (NSString*)SSLAcceptServerCertIssuer;

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

- (NSString*)SSLAcceptServerCertPrivateKey;

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

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

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

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

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

- (NSString*)SSLAcceptServerCertPublicKey;

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

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

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

- (int)SSLAcceptServerCertPublicKeyLength;

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

- (NSString*)SSLAcceptServerCertSerialNumber;

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

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

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

- (NSString*)SSLAcceptServerCertSubjectAltNames;

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

- (NSString*)SSLAcceptServerCertThumbprintMD5;

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

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

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

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

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

- (NSString*)SSLAcceptServerCertUsage;

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

- (int)SSLAcceptServerCertUsageFlags;

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

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

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

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

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

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

Default Value

""

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (WebDAV Module)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• Swift
• Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)SSLCertEffectiveDate;

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

- (NSString*)SSLCertExpirationDate;

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

- (NSString*)SSLCertExtendedKeyUsage;

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

- (NSString*)SSLCertFingerprint;

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

- (NSString*)SSLCertFingerprintSHA1;

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

- (NSString*)SSLCertFingerprintSHA256;

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

- (NSString*)SSLCertIssuer;

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

- (NSString*)SSLCertPrivateKey;

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

- (BOOL)SSLCertPrivateKeyAvailable;

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

- (NSString*)SSLCertPrivateKeyContainer;

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

- (NSString*)SSLCertPublicKey;

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

- (NSString*)SSLCertPublicKeyAlgorithm;

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

- (int)SSLCertPublicKeyLength;

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

- (NSString*)SSLCertSerialNumber;

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

- (NSString*)SSLCertSignatureAlgorithm;

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

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

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

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

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

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

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

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

- (NSString*)SSLCertSubjectAltNames;

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

- (NSString*)SSLCertThumbprintMD5;

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

- (NSString*)SSLCertThumbprintSHA1;

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

- (NSString*)SSLCertThumbprintSHA256;

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

- (NSString*)SSLCertUsage;

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

- (int)SSLCertUsageFlags;

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

- (NSString*)SSLCertVersion;

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

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

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

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

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

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

Default Value

""

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (WebDAV Module)

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• Swift
• Objective-C

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

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

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

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

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCert Property (WebDAV Module)

This property includes the server certificate for the last established connection.

Syntax

• Swift
• Objective-C

public var sslServerCert: Certificate {
  get {...}
}

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

- (NSString*)SSLServerCertEffectiveDate;

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

- (NSString*)SSLServerCertExpirationDate;

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

- (NSString*)SSLServerCertExtendedKeyUsage;

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

- (NSString*)SSLServerCertFingerprint;

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

- (NSString*)SSLServerCertFingerprintSHA1;

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

- (NSString*)SSLServerCertFingerprintSHA256;

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

- (NSString*)SSLServerCertIssuer;

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

- (NSString*)SSLServerCertPrivateKey;

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

- (BOOL)SSLServerCertPrivateKeyAvailable;

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

- (NSString*)SSLServerCertPrivateKeyContainer;

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

- (NSString*)SSLServerCertPublicKey;

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

- (NSString*)SSLServerCertPublicKeyAlgorithm;

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

- (int)SSLServerCertPublicKeyLength;

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

- (NSString*)SSLServerCertSerialNumber;

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

- (NSString*)SSLServerCertSignatureAlgorithm;

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

- (NSString*)SSLServerCertStore;

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

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

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

- (int)SSLServerCertStoreType;

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

- (NSString*)SSLServerCertSubjectAltNames;

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

- (NSString*)SSLServerCertThumbprintMD5;

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

- (NSString*)SSLServerCertThumbprintSHA1;

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

- (NSString*)SSLServerCertThumbprintSHA256;

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

- (NSString*)SSLServerCertUsage;

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

- (int)SSLServerCertUsageFlags;

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

- (NSString*)SSLServerCertVersion;

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

- (NSString*)SSLServerCertSubject;

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

- (NSString*)SSLServerCertEncoded;

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

- (NSData*)SSLServerCertEncodedB;
 

Default Value

""

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

StatusLine Property (WebDAV Module)

This property is the first line of the last server response.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)statusLine;

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description].

This property is read-only.

Timeout Property (WebDAV Module)

This property includes the timeout for the module.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class .

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.

TransferredData Property (WebDAV Module)

This property includes the contents of the last response from the server.

Syntax

• Swift
• Objective-C

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

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

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

- (NSString*)transferredData;

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

- (NSData*)transferredDataB;

Default Value

""

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only.

TransferredHeaders Property (WebDAV Module)

This property includes the full set of headers as received from the server.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)transferredHeaders;

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the class.

This property is read-only.

User Property (WebDAV Module)

This property includes a user name if authentication is to be used.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=user,setter=setUser:) NSString* user;

- (NSString*)user;
- (void)setUser :(NSString*)newUser;

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

AddCookie Method (WebDAV Module)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• Swift
• Objective-C

public func addCookie(cookieName: String, cookieValue: String) throws -> Void

- (void)addCookie:(NSString*)cookieName :(NSString*)cookieValue;

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddNamespace Method (WebDAV Module)

This method adds a namespace to the Namespaces properties.

Syntax

• Swift
• Objective-C

public func addNamespace(prefix: String, namespaceURI: String) throws -> Void

- (void)addNamespace:(NSString*)prefix :(NSString*)namespaceURI;

Remarks

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

CheckFileExists Method (WebDAV Module)

Checks if a file exists in the specified URI.

Syntax

• Swift
• Objective-C

public func checkFileExists(resourceURI: String) throws -> Bool

- (BOOL)checkFileExists:(NSString*)resourceURI;

Remarks

This method returns if the file exists on the specific endpoint provided by the ResourceURI parameter. It returns if the file does not exist.

Config Method (WebDAV Module)

This method sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyResource Method (WebDAV Module)

This method copies a resource to a new location.

Syntax

• Swift
• Objective-C

public func copyResource(sourceResourceURI: String, destinationResourceURI: String) throws -> Void

- (void)copyResource:(NSString*)sourceResourceURI :(NSString*)destinationResourceURI;

Remarks

The CopyResource method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI using the WebDAV COPY method.

This method is associated with the Depth property. If Depth is set to 0, the class will copy only SourceResourceURI. If Depth is set to infinity, the class will copy SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

DeleteResource Method (WebDAV Module)

This method deletes a resource.

Syntax

• Swift
• Objective-C

public func deleteResource(resourceURI: String) throws -> Void

- (void)deleteResource:(NSString*)resourceURI;

Remarks

The resource or collection specified by ResourceURIis deleted using the WebDAV DELETE method. The DeleteResource method behaves independently of the Depth property. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (i.e., all internal member URIs denoting single resources or collections are deleted). If ResourceURI denotes a non-collection resource, it is first removed from any collection that it contains, and then the resource is removed from the server.

DoEvents Method (WebDAV Module)

This method processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

FindProperties Method (WebDAV Module)

This method is used to get resource property values from the server.

Syntax

• Swift
• Objective-C

public func findProperties(resourceURI: String) throws -> Void

- (void)findProperties:(NSString*)resourceURI;

Remarks

This method fetches the properties for the resources using the WebDAV PROPFIND method. If there are properties (with names) set in the Properties* properties then the values for only those properties will be requested. If no properties are set in the Properties* properties, then the all the properties for the specified resource will be requested.

The response will populate the Properties* properties and will fire the ResourceProperties event once for each property returned.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

FindPropertyNames Method (WebDAV Module)

This method is used to get resource property names from the server.

Syntax

• Swift
• Objective-C

public func findPropertyNames(resourceURI: String) throws -> Void

- (void)findPropertyNames:(NSString*)resourceURI;

Remarks

FindPropertyNames will request names of all the properties of ResourceURI. The matching URIs will be returned through one or more ResourceProperties events (one for each matching resource), and the property names will be provided through the Properties properties.

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

GetProperty Method (WebDAV Module)

This method is used to get the value for a particular property.

Syntax

• Swift
• Objective-C

public func getProperty(propertyName: String) throws -> String

- (NSString*)getProperty:(NSString*)propertyName;

Remarks

The class will search through its internal Properties* properties for the property identified by PropertyName and will return the value associated with it.

PropertyName may also be a partial XPath expression to the retrieved resource XML. This method is useful for reading values of composite properties.

Note: This method does not make a request to the WebDAV server for a list of properties. The FindProperties method must be called first to issue the WebDAV PROPFIND request and populate the Properties* properties.

GetResource Method (WebDAV Module)

This method uses a WebDAV GET method to get a resource.

Syntax

• Swift
• Objective-C

public func getResource(resourceURI: String) throws -> Void

- (void)getResource:(NSString*)resourceURI;

Remarks

This method requests a resource using the WebDAV GET method. When the DAV server responds, the resource contents are delivered through the Transfer event, and the HTTP response headers are delivered through the Header event. Additionally, the resource contents are saved to the specified LocalFile or the TransferredData property respectively.

Interrupt Method (WebDAV Module)

This method interrupts the current method.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

ListDirectory Method (WebDAV Module)

This method lists the files and subdirectories of the ResourceURI .

Syntax

• Swift
• Objective-C

public func listDirectory(resourceURI: String) throws -> Void

- (void)listDirectory:(NSString*)resourceURI;

Remarks

This method will return a list of resources from the specified URI. The results will be returned through one or more DirList events (one for each matching resource).

Depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return the response HTTP 403 Forbidden.

LockResource Method (WebDAV Module)

This method is used to obtain a lock for a specified resource.

Syntax

• Swift
• Objective-C

public func lockResource(resourceURI: String) throws -> Void

- (void)lockResource:(NSString*)resourceURI;

Remarks

The LockResource method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

This method is associated with the Depth property. If Depth is set to 0, the class will lock only ResourceURI and its properties. If Depth is set to infinity, the class will lock ResourceURI and its entire subtree.

If MoveResource or CopyResource are used to place a resource or collection in a location under a resource locked with infinity, the new resource or collection will be added to the lock. Any lock on a collection will prevent nonlock owners from adding resources to that collection.

MakeDirectory Method (WebDAV Module)

This method can be used to make a new directory.

Syntax

• Swift
• Objective-C

public func makeDirectory(resourceURI: String) throws -> Void

- (void)makeDirectory:(NSString*)resourceURI;

Remarks

A new resource collection is created at the location specified by ResourceURI.

MoveResource Method (WebDAV Module)

This method moves one resource to a new location.

Syntax

• Swift
• Objective-C

public func moveResource(sourceResourceURI: String, destinationResourceURI: String) throws -> Void

- (void)moveResource:(NSString*)sourceResourceURI :(NSString*)destinationResourceURI;

Remarks

The MoveResource method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to 0, the class will move only SourceResourceURI. If Depth is set to infinity, the class will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a LockResource of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

PatchProperties Method (WebDAV Module)

This method updates the current set of properties on the server.

Syntax

• Swift
• Objective-C

public func patchProperties(resourceURI: String) throws -> Void

- (void)patchProperties:(NSString*)resourceURI;

Remarks

When the user calls PatchProperties, the class will send a request to the server to update the existing property list. The method is linked to the Properties property: the class will use the Operation field to tell the server what to do with the properties.

PostToResource Method (WebDAV Module)

This method posts data to a resource using the WebDAV POST method.

Syntax

• Swift
• Objective-C

public func postToResource(resourceURI: String) throws -> Void

- (void)postToResource:(NSString*)resourceURI;

Remarks

This method posts data to the resource ResourceURI using the WebDAV POST method. The posted data are taken from ResourceData. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile property is not empty, the data (not the headers) are written there as well.

PutResource Method (WebDAV Module)

This method sends data to the server using the PUT method.

Syntax

• Swift
• Objective-C

public func putResource(resourceURI: String) throws -> Void

- (void)putResource:(NSString*)resourceURI;

Remarks

The data are taken from LocalFile. The server will normally require authentication for this operation, so User and Password must have valid values before the request is made.

Reset Method (WebDAV Module)

This method will reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method will reset the class's properties to their default values.

SendCustomRequest Method (WebDAV Module)

This method sends a custom request to the WebDAV server.

Syntax

• Swift
• Objective-C

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

- (void)sendCustomRequest:(NSString*)httpMethod :(NSString*)url :(NSString*)requestBody;

Remarks

This method can be used to send arbitrary requests to a WebDAV server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• PROPFIND
• PROPPATCH
• MKCOL
• COPY
• MOVE
• LOCK
• UNLOCK

The value passed for URL is used as the location the request is made to. The RequestBody parameter is used to provide the component with the request body for the request. If no request body is needed for the request, the RequestBody parameter should also then be set to an empty string. If preferred, the request body can be provided via the LocalFile property instead. When doing so, the RequestBody parameter must be set to an empty string.

Note, the LocalFile property is not cleared after the request is made and should be cleared by either calling Reset or be setting it to an empty string.

When the server responds, the class stores the response headers in the ParsedHeader* properties and the response body in the specified LocalFile or the TransferredData property (using the same logic as GetResource). If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

SetProperty Method (WebDAV Module)

This method sets the value of a property.

Syntax

• Swift
• Objective-C

public func setProperty(propertyName: String, propertyValue: String) throws -> Void

- (void)setProperty:(NSString*)propertyName :(NSString*)propertyValue;

Remarks

This method is used to set a single property to a certain value. The name and new value of the property must be supplied in the parameters for this method.

Note: This is the same as calling the PatchProperties on one property when the operation is opSet.

Example. Set Property:

Control.SetProperty("MyProperty", "MyValue")

is equivalent to: Control.PropertyCount = 1 Control.PropertyName(0) = "MyProperty" Control.PropertyValue(0) = "MyValue" Control.PropertyOperation(0) = opSet Control.PatchProperties()

UnLockResource Method (WebDAV Module)

This method unlocks a resource.

Syntax

• Swift
• Objective-C

public func unLockResource(resourceURI: String) throws -> Void

- (void)unLockResource:(NSString*)resourceURI;

Remarks

Before calling UnLockResource on a particular resource, the LockTokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or nonprivileged users to access and operate on the file.

Connected Event (WebDAV Module)

This event is fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(statusCode: Int32, description: String)

- (void)onConnected:(int)statusCode :(NSString*)description;

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (WebDAV Module)

This event is fired to indicate changes in the connection state.

Syntax

• Swift
• Objective-C

func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String)

- (void)onConnectionStatus:(NSString*)connectionEvent :(int)statusCode :(NSString*)description;

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (WebDAV Module)

This event fires for each entry returned in a directory listing.

Syntax

• Swift
• Objective-C

func onDirList(resourceURI: String, displayName: String, contentLanguage: String, contentLength: Int64, contentType: String, lastModified: String)

- (void)onDirList:(NSString*)resourceURI :(NSString*)displayName :(NSString*)contentLanguage :(long long)contentLength :(NSString*)contentType :(NSString*)lastModified;

Remarks

The DirList event is fired when a directory listing is received as a response to ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and the end of the event stream.

Disconnected Event (WebDAV Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(statusCode: Int32, description: String)

- (void)onDisconnected:(int)statusCode :(NSString*)description;

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (WebDAV Module)

This event is fired when a document finishes transferring.

Syntax

• Swift
• Objective-C

func onEndTransfer(direction: Int32)

- (void)onEndTransfer:(int)direction;

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (WebDAV Module)

This event is fired for information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (WebDAV Module)

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

Syntax

• Swift
• Objective-C

func onHeader(field: String, value: String)

- (void)onHeader:(NSString*)field :(NSString*)value;

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (WebDAV Module)

This event fires once for each log message.

Syntax

• Swift
• Objective-C

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

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

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (WebDAV Module)

This event is fired when a redirection is received from the server.

Syntax

• Swift
• Objective-C

func onRedirect(location: String, accept: inout Bool)

- (void)onRedirect:(NSString*)location :(int*)accept;

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class . Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

ResourceProperties Event (WebDAV Module)

This event fires for each entry returned through a property search.

Syntax

• Swift
• Objective-C

func onResourceProperties(resourceURI: String, resourceProperties: String)

- (void)onResourceProperties:(NSString*)resourceURI :(NSString*)resourceProperties;

Remarks

The ResourceProperties event is fired when resource properties are received as a response to FindProperties.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The ResourceProperties contains the full XML containing the properties of the resource.

ResourceURI contains the name of the resource.

The parsed property names, values, and status are contained within the Properties properties.

SetCookie Event (WebDAV Module)

This event is fired for every cookie set by the server.

Syntax

• Swift
• Objective-C

func onSetCookie(name: String, value: String, expires: String, domain: String, path: String, secure: Bool)

- (void)onSetCookie:(NSString*)name :(NSString*)value :(NSString*)expires :(NSString*)domain :(NSString*)path :(BOOL)secure;

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (WebDAV Module)

This event is fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

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

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

Remarks

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.

SSLStatus Event (WebDAV Module)

This event shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (WebDAV Module)

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

Syntax

• Swift
• Objective-C

func onStartTransfer(direction: Int32)

- (void)onStartTransfer:(int)direction;

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (WebDAV Module)

This event is fired when the HTTP status line is received from the server.

Syntax

• Swift
• Objective-C

func onStatus(httpVersion: String, statusCode: Int32, description: String)

- (void)onStatus:(NSString*)HTTPVersion :(int)statusCode :(NSString*)description;

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (WebDAV Module)

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

Syntax

• Swift
• Objective-C

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

- (void)onTransfer:(int)direction :(long long)bytesTransferred :(int)percentDone :(NSData*)text;

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public init()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public init(encoded: )

Parses Encoded as an X509 public key.

public init(storeType: , store: , storePassword: , subject: )

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public init(storeType: , store: , storePassword: , subject: )

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

DAVProperty Type

A property that is either sent to or received from the server.

Remarks

This type defines a property that is used when the class sends a property find or patch request to the server. When FindProperties is used, this property will be populated with the properties returned from the server. When a call is made to PatchProperties, the class will use the information provided by this type to tell the server what to do with the property being specified.

Fields

Constructors

public init()

public init(name: )

DAVResource Type

A resource as returned in a directory listing from the WebDAV component.

Remarks

This type describes a resource that has been returned by the server during a response to a ListDirectory request. The DAVResource type contains fields which describe each listing as returned from the server.

Fields

Constructors

public init()

Firewall Type

This is the firewall the component will connect through.

Remarks

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

Fields

Constructors

public init()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

Constructors

public init()

public init(field: , value: )

HTTPCookie Type

An HTTP cookie can be either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.

Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Constructors

public init()

public init(name: , value: )

Proxy Type

This is the proxy the component will connect to.

Remarks

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

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the and the of the namespace being defined.

The default namespace exists at index 0. The field at index 0 is xmlns, and the field contains the default namespace.

Fields

Constructors

public init()

public init(uRI: , prefix: )

Config Settings (WebDAV Module)

WebDAV Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (WebDAV Module)

WebDAV Errors

HTTP Errors

SSLClient Errors

SSL Errors

TCP/IP Errors