| DAVClient Class |
Provides the host Connection and DAV request and response methods (DAVConnection).
Inheritance HierarchyNamespace: ARPDev.DAVLIB
Assembly: ARPDev.DAVLIB (in ARPDev.DAVLIB.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxThe DAVClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DAVClient |
Constructs a new DAVClient/DAVConnection
|
| DAVClient(String, Boolean, String, String) |
Constructs a new DAVClient/DAVConnection
|
| DAVClient(String, Int32, Boolean, String, String) |
Constructs a new DAVClient/DAVConnection
|
Methods| Name | Description | |
|---|---|---|
| addDAVItem |
Adds a DAV item to the server
|
| deleteDAVItem |
Deletes a DAV item on the server
|
| discoverResource |
Responsible for locating a DAV Container according to it's type.
|
| Equals | (Inherited from Object.) |
| FetchFolders |
This pre-populates the folder list for a connection (rather than having them be discovered/fetched on the fly)
|
 | Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| getCalendarItems |
Returns the items within a Calendar (or limits to the list of ItemIds defined in ItemList)
|
| getContactItems |
Returns a list of Contacts within a collection.
If ItemList is blank or Nothing, it returns everything (if it has itemids/filenames, then only those items are returned)
If bGetData is true, then it will return the actual vcards for the contacts as well.
|
| GetContainerTypeByName |
Uses the name of the folder to determine the type
|
| getDAVFreeBusy |
Fetches the free busy data calendar output for a user
|
| GetFolder |
Locates a FolderItem by it's string Name
|
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| getItems |
Returns the items within a collection
|
| getObjectRequest |
Queries the URI for a DAV Collection/DAVContainer and returns its properties within DAVObject
|
| getObjectState |
Issues a request to the server to determine the state of an object (to determine whether it has changed or not)
|
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| GetXMLNodeString |
Support function to return the string for a given XML Node
|
| GetXMLNodeURI |
Builds a URI Object from an XML Node value
|
| IssueRequest |
Issues a DAV Request to the DAV Host
(Inherited from DAVConnection.) |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NormaliseCrLf |
Normalises LineFeeds to Crlf
|
| parseDAVItemList |
Issues a request for Contact data to the server and then parses the response.
If ItemList is blank or Nothing, it returns everything (if it has itemids/filenames, then only those items are returned)
If bGetData is true, then it will return the actual vcards for the contacts as well.
|
| parseFreeBusyRequest |
Parses the result of a free/busy request
|
| parseObjectProperties |
Parses the response returned for a given DAV Object/Collection
|
| parseObjectResponse |
Parses a DAV Object response to derive the properties of a DAVObject
|
| parseObjectState |
Parses a DAV Object State response to determine whether it has changed
|
| parseResolveObjectRequest |
Parses the response to a resolve object request
|
| PollFolderForChanges |
Polls a dav folder for changes and returns when it either expires or there is a change
|
| resolveObjectRequest |
Attempts to find and collections of a specified FolderType under the HomeSetURL
|
| searchForObject |
Searches a returned XML Response for a given resource/object according to the specified container type (FolderType)
|
| SetConnection |
Sets the connection details
(Inherited from DAVConnection.) |
| ToString | (Inherited from Object.) |
| updateDAVItem |
Updates a dav item on the server
|
Fields| Name | Description | |
|---|---|---|
 | bLog |
Used to enable/disable logging
(Inherited from DAVConnection.) |
| FolderItems |
List of DAVFolders represented by their string names (ie: Contacts,Calendar,Tasks,$GAL)
|
| isSSL |
Used to denote whether or not SSL is used or not
(Inherited from DAVConnection.) |
| LogString |
Used to store any logged function results
(Inherited from DAVConnection.) |
| Password |
User's password
(Inherited from DAVConnection.) |
| Port |
Service port number
(Inherited from DAVConnection.) |
| ProxyPassword |
Proxy Server Password (if proxy is required)
(Inherited from DAVConnection.) |
| ProxyUserName |
Proxy Server Username (if proxy is required)
(Inherited from DAVConnection.) |
| ServerCapability |
Used to store a list of features/capabilities supported by the server
(Inherited from DAVConnection.) |
| UserName |
Username/Login
(Inherited from DAVConnection.) |
Properties| Name | Description | |
|---|---|---|
 | Host |
Host Name or IP Address of target server
(Inherited from DAVConnection.) |
RemarksProvides the host connection details and DAV request and response methods
ExamplesThe following example creates a simple contact and posts it to the server:
Dim davClient As DAVClient = New ARPDev.DAVLIB.DAVClient("host.example.com", false, "user@example.com", "password")
With davClient.GetFolder("Contacts")
Dim vcSimpleCard As New VCard("FirstName", "Surname", "Company", "User@example.com")
Dim oItem As DAVItem = .CreateItem(vcSimpleCard)
MsgBox("Created: " + oItem.ItemId)
End With
Dim davClient As DAVClient = New ARPDev.DAVLIB.DAVClient("host.example.com", false, "user@example.com", "password")
With davClient.GetFolder("Contacts")
Dim vcSimpleCard As New VCard("FirstName", "Surname", "Company", "User@example.com")
Dim oItem As DAVItem = .CreateItem(vcSimpleCard)
MsgBox("Created: " + oItem.ItemId)
End With
See Also