IP*Works! WebDav Component : WebDav OCX, WebDav .NET Component, WebDav Class, WebDav Bean, WebDav Object

Available in: IP*WORKS! | SSH | SSL

Webdav Class

WebDAV Component [IP*Works! V8]

Properties Methods Events Configuration Settings

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The component allows remote management of resource properties and properties , including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The ListDirectory and FindProperties methods will list the properties of a resource properties or resource, and a DirList or ResourceProperties event will be fired 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.

A number of operations can be performed on resources by using the various methods of the component. Please refer to the individual methods for more information.

WebDAV allows non-standard properties to be specified through XML namespaces.

The namespaces are provided in the Namespaces properties , which is filled automatically when retrieving DAV responses, but must be filled manually when requesting non-standard properties.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Accept	A list of acceptable MIME types for the request.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Connected	Shows whether the component is connected.
Cookies	Collection of cookies.
Depth	The depth associated with the current operation.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
LocalFile	The path to a local file used for DAV operations.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LockOwner	The principle that owns the current resource lock.
LockScope	The scope of the current resource lock.
LockTimeout	The time to live for the current resource lock.
LockTokens	The lock string to be used when submitting operations on a locked resource.
LockType	The type of the current resource lock.
Namespaces	Collection of namespaces in the current stack.
OtherHeaders	Other headers as determined by the user (optional).
ParsedHeaders	Collection of headers returned from the last request.
Password	A password if authentication is to be used.
Properties	A collection of WebDAV properties.
Proxy	A set of properties related to proxy access.
Referer	Referer URL/document (optional).
Resources	Collection of resources resulting from the last directory listing.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum of data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
User	A user name if authentication is to be used.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
AddNamespace	Adds a namespace to the Namespaces properties .
Config	Sets or retrieves a component configuration setting.
CopyResource	Copy a resource to a new location.
DeleteResource	Delete a resource.
DoEvents	Processes events from the internal message queue.
FindProperties	Get resource property values from the server.
FindPropertyNames	Get resource property names from the server.
GetProperty	Get the value for a particular property.
GetResource	Get a resource using the WebDAV GET method.
Interrupt	Interrupt the current method.
ListDirectory	List the files and subdirectories of the ResourceURI.
LockResource	Obtain a lock for a specified resource.
MakeDirectory	Make a new directory.
MoveResource	Moves one resource to a new location.
PatchProperties	Update the current set of properties on the server.
PostToResource	Posts data to a resource using the WebDAV POST method.
PutResource	Send data to the server using the PUT method.
Reset	Reset the component.
SetDownloadStream	Sets the stream to which the downloaded data from the server will be written.
SetProperty	Set the value of a property.
SetUploadStream	Sets the stream to be uploaded to the server.
UnLockResource	Unlocks a resource.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fires for each entry returned in a directory listing.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
ResourceProperties	Fires for each entry returned through a property search.
SetCookie	Fired for every cookie set by the server.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EncodeURL	If set to true the URL will be encoded by the component.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxResources	Instructs component to save the amount of resources specified that are returned by the server after a ListDirectory call has been made.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TcpNoDelay	Whether or not to delay when sending packets
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UserAgent	Information about the user agent (browser).