IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

WebDAV Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Class Name

IPWorks_WebDAV

Procedural Interface

 ipworks_webdav_open();
 ipworks_webdav_close($res);
 ipworks_webdav_register_callback($res, $id, $function);
 ipworks_webdav_get_last_error($res);
 ipworks_webdav_get_last_error_code($res);
 ipworks_webdav_set($res, $id, $index, $value);
 ipworks_webdav_get($res, $id, $index);
 ipworks_webdav_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_webdav_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_webdav_do_config($res, $configurationstring);
 ipworks_webdav_do_copyresource($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_webdav_do_deleteresource($res, $resourceuri);
 ipworks_webdav_do_doevents($res);
 ipworks_webdav_do_findproperties($res, $resourceuri);
 ipworks_webdav_do_findpropertynames($res, $resourceuri);
 ipworks_webdav_do_getproperty($res, $propertyname);
 ipworks_webdav_do_getresource($res, $resourceuri);
 ipworks_webdav_do_interrupt($res);
 ipworks_webdav_do_listdirectory($res, $resourceuri);
 ipworks_webdav_do_lockresource($res, $resourceuri);
 ipworks_webdav_do_makedirectory($res, $resourceuri);
 ipworks_webdav_do_moveresource($res, $sourceresourceuri, $destinationresourceuri);
 ipworks_webdav_do_patchproperties($res, $resourceuri);
 ipworks_webdav_do_posttoresource($res, $resourceuri, $postdata);
 ipworks_webdav_do_putresource($res, $resourceuri);
 ipworks_webdav_do_reset($res);
 ipworks_webdav_do_setproperty($res, $propertyname, $propertyvalue);
 ipworks_webdav_do_unlockresource($res, $resourceuri);

Remarks

The class 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.

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

A number of operations can be performed on resources by using the various methods of the class. 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 class with short descriptions. Click on the links for further details.

AcceptA list of acceptable MIME types for the request.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ConnectedShows whether the component is connected.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThe domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThe name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
DepthThe depth associated with the current operation.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
LocalFileThe path to a local file used for DAV operations.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LockOwnerThe principle that owns the current resource lock.
LockScopeThe scope of the current resource lock.
LockTimeoutThe time to live for the current resource lock.
LockTokensThe lock string to be used when submitting operations on a locked resource.
LockTypeThe type of the current resource lock.
NamespaceCountThe number of records in the Namespace arrays.
NamespacePrefixThe Prefix for the Namespace .
NamespaceURINamespace URI associated with the corresponding Prefix .
OtherHeadersOther headers as determined by the user (optional).
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PasswordA password if authentication is to be used.
PropertyCountThe number of records in the Property arrays.
PropertyAttrThis property shows the attribute string for the specified DAV property.
PropertyNameThis property shows the name of the DAV property sent to or received from the server.
PropertyNamespaceURIThis property shows the DAV property namespace.
PropertyOperationThis property shows the operation to perform on a property when calling PatchProperties .
PropertyStatusThis property shows the status of the retrieved DAV property.
PropertyValueThis property shows the value of the DAV property.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RefererReferer URL/document (optional).
ResourceCountThe number of records in the Resource arrays.
ResourceContentLanguageThis property shows the language of the resource being returned.
ResourceContentLengthThis property shows the length of the resource returned.
ResourceContentTypeThis property shows the type of the resource being returned.
ResourceDisplayNameThis property shows the name of the resource being listed.
ResourceLastModifiedThis property shows the date/time stamp of the last time the resource was modified.
ResourceURIThis property shows the URI of the resource being returned.
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
UserA user name if authentication is to be used.

Method List


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

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AddNamespaceAdds a namespace to the Namespaces properties.
ConfigSets or retrieves a configuration setting .
CopyResourceCopy a resource to a new location.
DeleteResourceDelete a resource.
DoEventsProcesses events from the internal message queue.
FindPropertiesGet resource property values from the server.
FindPropertyNamesGet resource property names from the server.
GetPropertyGet the value for a particular property.
GetResourceGet a resource using the WebDAV GET method.
InterruptInterrupt the current method.
ListDirectoryList the files and subdirectories of the ResourceURI .
LockResourceObtain a lock for a specified resource.
MakeDirectoryMake a new directory.
MoveResourceMoves one resource to a new location.
PatchPropertiesUpdate the current set of properties on the server.
PostToResourcePosts data to a resource using the WebDAV POST method.
PutResourceSend data to the server using the PUT method.
ResetReset the component.
SetPropertySet the value of a property.
UnLockResourceUnlocks a resource.

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.

ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DirListFires for each entry returned in a directory listing.
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
RedirectFired when a redirection is received from the server.
ResourcePropertiesFires for each entry returned through a property search.
SetCookieFired for every cookie set by the server.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

EncodeURLIf set to true the URL will be encoded by the component.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0