CardDAV Class

Properties   Methods   Events   Config Settings   Errors  

The CardDAV class makes it easy to access, share, manage, upload, and download contact data based on the vCard format within a CardDAV server.

Syntax

CardDAV

Remarks

The CardDAV class allows management of address books and their contacts. Capabilities include creation, deletion, updating, listing, copying, and moving of contacts and address books. The following sections provide additional details about common operations.

Authentication

This class may require authentication via OAuth 2.0 depending on the provider. For example Google requires OAuth 2.0. Perform OAuth authentication using the OAuth class or a separate process. Once complete, you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Addressing Resources

The CardDAV class allows resources to be addressed using a resource URI. There is no standard format for a resource URI, though in most cases the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name".

Google uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" to access the default address book. Below is an example of using the GetAddressbookReport method, which makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

To add, delete, update, copy or move a contact from an address book, add its file name at the end of the address book URI, which typically has a vcf extension. Usually the filename of a contact is the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources.

Listing Address Books

ListAddressbooks lists all address books that the current user can access. When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get addressbook-home-set for the user. The addressbook-home-set is then used by the class to make a final PROPFIND request to get the list of address books for the user.

Once this method returns, the class will populate the Addressbooks collection. For example:

cardDAV.ListAddressbooks("https://mydavserver/.well-known/carddav/Address_Book_Name"); for (int i = 0; i < cardDAV.Addressbooks.Count; i++) { string url = cardDAV.Addressbooks[i].URL; string displayName = cardDAV.Addressbooks[i].DisplayName; }

Managing Address Books

To create an address book use the CreateAddressbook method. The resource URI would be similar to "https://mydavserver/.well-known/carddav/New_Address_Book" and it should be unique. The last part of the URI is not the display name of the address book, but is needed to retrieve/update/delete the addressbook. Specify the display name and the description as arguments when calling CreateAddressbook.

To update an address book iterate through Addressbooks to find the index of the address book to be updated. Set the properties of the address book to the desired values and then make a call to UpdateAddressbook.

To delete an address book use the DeleteAddressbook method and provide the URI of the address book. The following example shows how to create, update and delete an address book: //create an address book cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book", "display_name", "description"); //update the address book cardDAV.Addressbooks[0].DisplayName = "display_name_updated"; cardDAV.Addressbooks[0].Description = "description_updated"; cardDAV.UpdateAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book", 0); //delete the address book cardDAV.DeleteAddressbook("https://mydavserver/.well-known/carddav/New_Address_Book");

Listing Contacts

To retrieve the contacts of an address book, invoke the GetAddressbookReport method, which sends an addressbook-query request to the address book located at the specified ResourceURI. The response to an addressbook-query report will be parsed by the class, and information about the individual contacts will be provided in the ContactDetails event.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

For example: cardDAV.User = "myusername"; cardDAV.Password = "mypassword"; cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/user@gmail.com/lists/default"); The following code inside the ContactDetails event will print the formatted name, phone number and email for each contact: Private Sub CardDAV_ContactDetails(ResourceURI As String, ResponseStatus As String, ETag As String, ContactData As String) Debug.Print cardDAV.FormattedName + " " + cardDAV.PhoneNumbers[0].Value + " " + cardDAV.EMails[0].Value End Sub The output from the above code will look like this:

John Smith  123-456-7890  john@example.com
Jane Doe  555-555-5555  jane@example.com
Alice Johnson 987-654-3210  alice@example.com 

Managing Contacts

The CreateContact, UpdateContact, DeleteContact, CopyContact, and MoveContact methods provide a way to manage individual contacts within an address book.

When calling CreateContact it is necessary to specify at least the formatted name of the object the contact represents. Additional information can be added to the contact by setting additional properties. Please refer to the CreateContact documentation for a complete list of applicable properties.

When calling UpdateContact set the properties to change for the contact and then make a call to UpdateContact.

When calling MoveContact or CopyContact specify the URI of the contact to be copied or moved, and the destination URI. When calling DeleteContact specify the URI of the contact to delete.

The example below shows a few possible operations: cardDAV.User = "username"; cardDAV.Password = "password"; //create a contact cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.EMails.Add(new CardCustomProp("email", "john@gmail.com")); CardCustomProp address1 = new CardCustomProp("address", ";;123 Main Street;Any Town;State;1234;Country Name"); address1.Attribute = "TYPE=home"; //optional cardDAV.Addresses.Add(address1); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); //update the contact cardDAV.NickName = "Johny"; cardDAV.PhoneNumbers[0] = new CardCustomProp("tel", "0123456789"); cardDAV.UpdateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); //move the contact cardDAV.MoveContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf", "https://mydavserver/.well-known/carddav/Another_Address_book/123456789.vcf"); //delete the contact cardDAV.DeleteContact("https://mydavserver/.well-known/carddav/Another_Address_book/123456789.vcf");

Creating and Retrieving Contacts using vCards

Another way to create a contact is by using ImportVCF to import all the data from a vCard object. For example: String vCard = File.ReadAllText("path/to/vcf/file"); cardDAV.ImportVCF(vCard); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); Retrieve a contact by using GetContact, then make a call to ExportVCF, which will convert the retrieved data to a vCard object. This can later be written to a standard VCF file. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); File.WriteAllText("path/to/vcf/file", cardDAV.ExportVCF());

Property List

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

Method List

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

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.

Config Settings

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

Addressbooks Property (CardDAV Class)

A collection of address books.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardAddressbookInfo>* GetAddressbooks();
int SetAddressbooks(IPWorksList<IPWorksCardAddressbookInfo>* val);

int ipworks_carddav_getaddressbookcount(void* lpObj);
int ipworks_carddav_setaddressbookcount(void* lpObj, int iAddressbookCount);

char* ipworks_carddav_getaddressbookctag(void* lpObj, int addressbookindex);
int ipworks_carddav_setaddressbookctag(void* lpObj, int addressbookindex, const char* lpszAddressbookCTag);

char* ipworks_carddav_getaddressbookdescription(void* lpObj, int addressbookindex);
int ipworks_carddav_setaddressbookdescription(void* lpObj, int addressbookindex, const char* lpszAddressbookDescription);

char* ipworks_carddav_getaddressbookdisplayname(void* lpObj, int addressbookindex);
int ipworks_carddav_setaddressbookdisplayname(void* lpObj, int addressbookindex, const char* lpszAddressbookDisplayName);

int ipworks_carddav_getaddressbookpropertycount(void* lpObj, int addressbookindex);

int ipworks_carddav_getaddressbookpropertyindex(void* lpObj, int addressbookindex);
int ipworks_carddav_setaddressbookpropertyindex(void* lpObj, int addressbookindex, int iAddressbookPropertyIndex);

char* ipworks_carddav_getaddressbookpropertyname(void* lpObj, int addressbookindex);

char* ipworks_carddav_getaddressbookpropertyvalue(void* lpObj, int addressbookindex);

char* ipworks_carddav_getaddressbookurl(void* lpObj, int addressbookindex);
int ipworks_carddav_setaddressbookurl(void* lpObj, int addressbookindex, const char* lpszAddressbookURL);

int GetAddressbookCount();
int SetAddressbookCount(int iAddressbookCount);

QString GetAddressbookCTag(int iAddressbookIndex);
int SetAddressbookCTag(int iAddressbookIndex, QString qsAddressbookCTag);

QString GetAddressbookDescription(int iAddressbookIndex);
int SetAddressbookDescription(int iAddressbookIndex, QString qsAddressbookDescription);

QString GetAddressbookDisplayName(int iAddressbookIndex);
int SetAddressbookDisplayName(int iAddressbookIndex, QString qsAddressbookDisplayName);

int GetAddressbookPropertyCount(int iAddressbookIndex);

int GetAddressbookPropertyIndex(int iAddressbookIndex);
int SetAddressbookPropertyIndex(int iAddressbookIndex, int iAddressbookPropertyIndex);

QString GetAddressbookPropertyName(int iAddressbookIndex);

QString GetAddressbookPropertyValue(int iAddressbookIndex);

QString GetAddressbookURL(int iAddressbookIndex);
int SetAddressbookURL(int iAddressbookIndex, QString qsAddressbookURL);

Remarks

This collection will hold data for each CardAddressbookInfo available to the current user. Calling ListAddressbooks will populate this collection.

Data Type

IPWorksCardAddressbookInfo

Addresses Property (CardDAV Class)

The address information for a contact.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardCustomProp>* GetAddresses();
int SetAddresses(IPWorksList<IPWorksCardCustomProp>* val);

int ipworks_carddav_getaddresscount(void* lpObj);
int ipworks_carddav_setaddresscount(void* lpObj, int iAddressCount);

char* ipworks_carddav_getaddressattribute(void* lpObj, int addressindex);
int ipworks_carddav_setaddressattribute(void* lpObj, int addressindex, const char* lpszAddressAttribute);

char* ipworks_carddav_getaddressname(void* lpObj, int addressindex);
int ipworks_carddav_setaddressname(void* lpObj, int addressindex, const char* lpszAddressName);

char* ipworks_carddav_getaddressvalue(void* lpObj, int addressindex);
int ipworks_carddav_setaddressvalue(void* lpObj, int addressindex, const char* lpszAddressValue);

int GetAddressCount();
int SetAddressCount(int iAddressCount);

QString GetAddressAttribute(int iAddressIndex);
int SetAddressAttribute(int iAddressIndex, QString qsAddressAttribute);

QString GetAddressName(int iAddressIndex);
int SetAddressName(int iAddressIndex, QString qsAddressName);

QString GetAddressValue(int iAddressIndex);
int SetAddressValue(int iAddressIndex, QString qsAddressValue);

Remarks

This property is used to specify one or more physical addresses associated with a contact. Its value consists of multiple structured text values representing different parts of the address, where each part is separated by the SEMI-COLON character (ASCII decimal 59). The structured address value corresponds, in sequence, to the post office box; the extended address; the street address; the locality (e.g., city); the region (e.g., state or province); the postal code; the country name. When a component value is missing, the associated component separator MUST still be specified. Each address can include parameters such as TYPE to specify the type of address (e.g., home, work, postal, etc.). Below is an example on how to use this property: CardCustomProp address1 = new CardCustomProp("address", "PO Box 123;123 Extended Address;123 Main Street;Any Town;State;1234;Country Name"); address1.Attribute = "TYPE=home"; //optional cardDAV.Addresses.Add(address1); CardCustomProp address1 = new CardCustomProp("address", ";;456 Main Street;Any Town;State;5678;Country Name"); address1.Attribute = "TYPE=work"; //optional cardDAV.Addresses.Add(address2);

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

Anniversary Property (CardDAV Class)

The date of marriage, or equivalent for a contact.

Syntax

• C++
• C
• Qt

IPWorksCardCustomProp* GetAnniversary();
int SetAnniversary(IPWorksCardCustomProp* val);

char* ipworks_carddav_getanniversaryattribute(void* lpObj);
int ipworks_carddav_setanniversaryattribute(void* lpObj, const char* lpszAnniversaryAttribute);

char* ipworks_carddav_getanniversaryname(void* lpObj);
int ipworks_carddav_setanniversaryname(void* lpObj, const char* lpszAnniversaryName);

char* ipworks_carddav_getanniversaryvalue(void* lpObj);
int ipworks_carddav_setanniversaryvalue(void* lpObj, const char* lpszAnniversaryValue);

QString GetAnniversaryAttribute();
int SetAnniversaryAttribute(QString qsAnniversaryAttribute);

QString GetAnniversaryName();
int SetAnniversaryName(QString qsAnniversaryName);

QString GetAnniversaryValue();
int SetAnniversaryValue(QString qsAnniversaryValue);

Remarks

This property represents the date of marriage, or equivalent, for a contact. It can be a single date-and-or-time or a single text value, for example: cardDAV.Anniversary = new CardCustomProp("anniversary", "19961212");

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

Authorization Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* ipworks_carddav_getauthorization(void* lpObj);
int ipworks_carddav_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

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

Data Type

String

AuthScheme Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5), 
AUTH_OAUTH(6)

int ipworks_carddav_getauthscheme(void* lpObj);
int ipworks_carddav_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

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.

Data Type

Integer

BirthDay Property (CardDAV Class)

The birth date of the contact.

Syntax

• C++
• C
• Qt

IPWorksCardCustomProp* GetBirthDay();
int SetBirthDay(IPWorksCardCustomProp* val);

char* ipworks_carddav_getbirthdayattribute(void* lpObj);
int ipworks_carddav_setbirthdayattribute(void* lpObj, const char* lpszBirthDayAttribute);

char* ipworks_carddav_getbirthdayname(void* lpObj);
int ipworks_carddav_setbirthdayname(void* lpObj, const char* lpszBirthDayName);

char* ipworks_carddav_getbirthdayvalue(void* lpObj);
int ipworks_carddav_setbirthdayvalue(void* lpObj, const char* lpszBirthDayValue);

QString GetBirthDayAttribute();
int SetBirthDayAttribute(QString qsBirthDayAttribute);

QString GetBirthDayName();
int SetBirthDayName(QString qsBirthDayName);

QString GetBirthDayValue();
int SetBirthDayValue(QString qsBirthDayValue);

Remarks

This property is used to specify the birth date of a contact. It can be a date-time value or a date value. Below is an example on how to use this property: cardDAV.BirthDay = new CardCustomProp("birthday", "1996-04-15");

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

Connected Property (CardDAV Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworks_carddav_getconnected(void* lpObj);

bool GetConnected();

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 and not available at design time.

Data Type

Boolean

Cookies Property (CardDAV Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHTTPCookie>* GetCookies();
int SetCookies(IPWorksList<IPWorksHTTPCookie>* val);

int ipworks_carddav_getcookiecount(void* lpObj);
int ipworks_carddav_setcookiecount(void* lpObj, int iCookieCount);

char* ipworks_carddav_getcookiedomain(void* lpObj, int cookieindex);

char* ipworks_carddav_getcookieexpiration(void* lpObj, int cookieindex);

char* ipworks_carddav_getcookiename(void* lpObj, int cookieindex);
int ipworks_carddav_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

char* ipworks_carddav_getcookiepath(void* lpObj, int cookieindex);

int ipworks_carddav_getcookiesecure(void* lpObj, int cookieindex);

char* ipworks_carddav_getcookievalue(void* lpObj, int cookieindex);
int ipworks_carddav_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

QString GetCookieDomain(int iCookieIndex);

QString GetCookieExpiration(int iCookieIndex);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

QString GetCookiePath(int iCookieIndex);

bool GetCookieSecure(int iCookieIndex);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

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.

This property is not available at design time.

Data Type

IPWorksHTTPCookie

CustomProperties Property (CardDAV Class)

List of extra properties that may be used to extend the functionality of this class.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardCustomProp>* GetCustomProperties();
int SetCustomProperties(IPWorksList<IPWorksCardCustomProp>* val);

int ipworks_carddav_getcustompropertycount(void* lpObj);
int ipworks_carddav_setcustompropertycount(void* lpObj, int iCustomPropertyCount);

char* ipworks_carddav_getcustompropertyattribute(void* lpObj, int custompropertyindex);
int ipworks_carddav_setcustompropertyattribute(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyAttribute);

char* ipworks_carddav_getcustompropertyname(void* lpObj, int custompropertyindex);
int ipworks_carddav_setcustompropertyname(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyName);

char* ipworks_carddav_getcustompropertyvalue(void* lpObj, int custompropertyindex);
int ipworks_carddav_setcustompropertyvalue(void* lpObj, int custompropertyindex, const char* lpszCustomPropertyValue);

int GetCustomPropertyCount();
int SetCustomPropertyCount(int iCustomPropertyCount);

QString GetCustomPropertyAttribute(int iCustomPropertyIndex);
int SetCustomPropertyAttribute(int iCustomPropertyIndex, QString qsCustomPropertyAttribute);

QString GetCustomPropertyName(int iCustomPropertyIndex);
int SetCustomPropertyName(int iCustomPropertyIndex, QString qsCustomPropertyName);

QString GetCustomPropertyValue(int iCustomPropertyIndex);
int SetCustomPropertyValue(int iCustomPropertyIndex, QString qsCustomPropertyValue);

Remarks

This property is used to add additional name/value pairs to the request. It is valid only for the CreateContact and UpdateContact methods. You may use this property to submit any CardDAV fields that are not directly supported by this class. You may also use it to send custom properties that are specific on the address book that you are using. Such custom properties normally start with "X-". For instance: cardDAV.CustomProperties.Add(new CardCustomProp("TEL", "123456789", "TYPE=home"));

Or alternatively: cardDAV.CustomProperties.Add(new CardCustomProp()); cardDAV.CustomProperties[0].Name = "TEL"; cardDAV.CustomProperties[0].Value = "123456789"; cardDAV.CustomProperties[0].Attribute = "TYPE=home";

The contents of the CustomProperties collection will only be added to the CreateContact or UpdateContact requests. They will be ignored for all other methods.

This property is not available at design time.

Data Type

IPWorksCardCustomProp

EMails Property (CardDAV Class)

The email address of a contact.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardCustomProp>* GetEMails();
int SetEMails(IPWorksList<IPWorksCardCustomProp>* val);

int ipworks_carddav_getemailcount(void* lpObj);
int ipworks_carddav_setemailcount(void* lpObj, int iEMailCount);

char* ipworks_carddav_getemailattribute(void* lpObj, int emailindex);
int ipworks_carddav_setemailattribute(void* lpObj, int emailindex, const char* lpszEMailAttribute);

char* ipworks_carddav_getemailname(void* lpObj, int emailindex);
int ipworks_carddav_setemailname(void* lpObj, int emailindex, const char* lpszEMailName);

char* ipworks_carddav_getemailvalue(void* lpObj, int emailindex);
int ipworks_carddav_setemailvalue(void* lpObj, int emailindex, const char* lpszEMailValue);

int GetEMailCount();
int SetEMailCount(int iEMailCount);

QString GetEMailAttribute(int iEMailIndex);
int SetEMailAttribute(int iEMailIndex, QString qsEMailAttribute);

QString GetEMailName(int iEMailIndex);
int SetEMailName(int iEMailIndex, QString qsEMailName);

QString GetEMailValue(int iEMailIndex);
int SetEMailValue(int iEMailIndex, QString qsEMailValue);

Remarks

This property is used to specify the email address for communication with a contact. It consists of a single text value representing the email address. Multiple EMails properties can be used to represent multiple email addresses for a contact. Additionally, each EMails property can include parameters such as TYPE to specify the type of email address (e.g., work, home, or other).

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

ETag Property (CardDAV Class)

Identifier returned by the CardDAV server which is used to synchronize edits.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetETag();
int SetETag(const char* lpszETag);

Unicode (Windows)
LPWSTR GetETag();
INT SetETag(LPCWSTR lpszETag);

char* ipworks_carddav_getetag(void* lpObj);
int ipworks_carddav_setetag(void* lpObj, const char* lpszETag);

QString GetETag();
int SetETag(QString qsETag);

Default Value

""

Remarks

This property identifies the state of the contact in the address book. ETag is returned by the CardDAV server after a successful CreateContact request. Every time a contact is updated, the ETag changes. This gives you the ability to determine if another user has changed the contact you added.

You can use the ETag value to maintain a cache. If you submit a GetAddressbookReport request with the ReturnContactData field set to False, only the ResourceURI and ETag for each contact in the address book will be returned in from ContactDetails. You can cache the ETag; and URI locally, and then inspect the report for any changes and update only the contacts that have changed ETags.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Firewall Property (CardDAV Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksFirewall* GetFirewall();
int SetFirewall(IPWorksFirewall* val);

int ipworks_carddav_getfirewallautodetect(void* lpObj);
int ipworks_carddav_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworks_carddav_getfirewalltype(void* lpObj);
int ipworks_carddav_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworks_carddav_getfirewallhost(void* lpObj);
int ipworks_carddav_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworks_carddav_getfirewallpassword(void* lpObj);
int ipworks_carddav_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworks_carddav_getfirewallport(void* lpObj);
int ipworks_carddav_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworks_carddav_getfirewalluser(void* lpObj);
int ipworks_carddav_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

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

Data Type

IPWorksFirewall

FollowRedirects Property (CardDAV Class)

Determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworks_carddav_getfollowredirects(void* lpObj);
int ipworks_carddav_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

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 fails with an error.

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 fails with an error instead.

Data Type

Integer

FormattedName Property (CardDAV Class)

The formatted name of the contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFormattedName();
int SetFormattedName(const char* lpszFormattedName);

Unicode (Windows)
LPWSTR GetFormattedName();
INT SetFormattedName(LPCWSTR lpszFormattedName);

char* ipworks_carddav_getformattedname(void* lpObj);
int ipworks_carddav_setformattedname(void* lpObj, const char* lpszFormattedName);

QString GetFormattedName();
int SetFormattedName(QString qsFormattedName);

Default Value

""

Remarks

This property is used to specify the formatted name of the contact. It can be a single text value based on the semantics of the X.520 Common Name attribute. It is required when creating a contact.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Gender Property (CardDAV Class)

The sex and gender identity of a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGender();
int SetGender(const char* lpszGender);

Unicode (Windows)
LPWSTR GetGender();
INT SetGender(LPCWSTR lpszGender);

char* ipworks_carddav_getgender(void* lpObj);
int ipworks_carddav_setgender(void* lpObj, const char* lpszGender);

QString GetGender();
int SetGender(QString qsGender);

Default Value

""

Remarks

This property is used to specify the sex and gender identity of a contact. It must be a single structured value with two parts, which are optional, separated by a semicolon.

The first part is the sex (biological), which could be:

• M (male)
• F (female)
• O (other)
• N (None)
• U (Unknown)

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Idle Property (CardDAV Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworks_carddav_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property 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.

Data Type

Boolean

Kind Property (CardDAV Class)

The kind of object the vCard represents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKind();
int SetKind(const char* lpszKind);

Unicode (Windows)
LPWSTR GetKind();
INT SetKind(LPCWSTR lpszKind);

char* ipworks_carddav_getkind(void* lpObj);
int ipworks_carddav_setkind(void* lpObj, const char* lpszKind);

QString GetKind();
int SetKind(QString qsKind);

Default Value

""

Remarks

This property is used to specify the kind of object the contact represents. The value may be:

• individual for a vCard representing a single person or entity.
• group for a vCard representing a group of persons or entities.
• org for a vCard representing an organization.
• location for a named geographical place.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Languages Property (CardDAV Class)

The language(s) that may be used for contacting the entity associated with the vCard.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardCustomProp>* GetLanguages();
int SetLanguages(IPWorksList<IPWorksCardCustomProp>* val);

int ipworks_carddav_getlanguagecount(void* lpObj);
int ipworks_carddav_setlanguagecount(void* lpObj, int iLanguageCount);

char* ipworks_carddav_getlanguageattribute(void* lpObj, int languageindex);
int ipworks_carddav_setlanguageattribute(void* lpObj, int languageindex, const char* lpszLanguageAttribute);

char* ipworks_carddav_getlanguagename(void* lpObj, int languageindex);
int ipworks_carddav_setlanguagename(void* lpObj, int languageindex, const char* lpszLanguageName);

char* ipworks_carddav_getlanguagevalue(void* lpObj, int languageindex);
int ipworks_carddav_setlanguagevalue(void* lpObj, int languageindex, const char* lpszLanguageValue);

int GetLanguageCount();
int SetLanguageCount(int iLanguageCount);

QString GetLanguageAttribute(int iLanguageIndex);
int SetLanguageAttribute(int iLanguageIndex, QString qsLanguageAttribute);

QString GetLanguageName(int iLanguageIndex);
int SetLanguageName(int iLanguageIndex, QString qsLanguageName);

QString GetLanguageValue(int iLanguageIndex);
int SetLanguageValue(int iLanguageIndex, QString qsLanguageValue);

Remarks

This property is used to specify the language(s) that may be used for contacting the entity associated with the vCard.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

LocalHost Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_carddav_getlocalhost(void* lpObj);
int ipworks_carddav_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This 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 IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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.

Data Type

String

Names Property (CardDAV Class)

The name of a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNames();
int SetNames(const char* lpszNames);

Unicode (Windows)
LPWSTR GetNames();
INT SetNames(LPCWSTR lpszNames);

char* ipworks_carddav_getnames(void* lpObj);
int ipworks_carddav_setnames(void* lpObj, const char* lpszNames);

QString GetNames();
int SetNames(QString qsNames);

Default Value

""

Remarks

This property is used to specify the name of a contact. It can be a single structured text value. The structured type value corresponds, in sequence, to the Family Name, Given Name, Additional Names, Honorific Prefixes, and Honorific Suffixes. The text components are separated by the SEMI-COLON character (ASCII decimal 59). Individual text components can include multiple text values (e.g., multiple Additional Names) separated by the COMMA character (ASCII decimal 44).

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

NickName Property (CardDAV Class)

The nickname of the object the vCard represents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNickName();
int SetNickName(const char* lpszNickName);

Unicode (Windows)
LPWSTR GetNickName();
INT SetNickName(LPCWSTR lpszNickName);

char* ipworks_carddav_getnickname(void* lpObj);
int ipworks_carddav_setnickname(void* lpObj, const char* lpszNickName);

QString GetNickName();
int SetNickName(QString qsNickName);

Default Value

""

Remarks

This property is used to specify the text corresponding to the nickname of a contact. It can be a single text value or a list of comma separated text values.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Note Property (CardDAV Class)

Provides additional information or comments about a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNote();
int SetNote(const char* lpszNote);

Unicode (Windows)
LPWSTR GetNote();
INT SetNote(LPCWSTR lpszNote);

char* ipworks_carddav_getnote(void* lpObj);
int ipworks_carddav_setnote(void* lpObj, const char* lpszNote);

QString GetNote();
int SetNote(QString qsNote);

Default Value

""

Remarks

This property is used to provide supplementary information or comments about a contact. It is typically used to record details such as personal preferences, specific instructions, reminders, or any other relevant information pertaining to the contact.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

Organization Property (CardDAV Class)

The organizational name and units associated with a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrganization();
int SetOrganization(const char* lpszOrganization);

Unicode (Windows)
LPWSTR GetOrganization();
INT SetOrganization(LPCWSTR lpszOrganization);

char* ipworks_carddav_getorganization(void* lpObj);
int ipworks_carddav_setorganization(void* lpObj, const char* lpszOrganization);

QString GetOrganization();
int SetOrganization(QString qsOrganization);

Default Value

""

Remarks

This property is used to specify the name of the organization and its units with which the contact is affiliated. It consists of one or more text values representing the organization's name and any additional units or divisions within the organization. The text components are separated by the SEMI-COLON character (ASCII decimal 59). Below is an example on how to use this property: cardDAV.Organization = "ABC Inc.;North American Division;Marketing";

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

OtherHeaders Property (CardDAV Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworks_carddav_getotherheaders(void* lpObj);
int ipworks_carddav_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

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 CRLF ("\r\n") .

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.

For CardDAV, the "If-Match" header is extremely useful. After adding a contact with CreateContact or retrieving a contact with GetContact, the ETag property will contain a value indicating the current state of the contact. If you wish to update the contact, you may pass this returned ETag in an "If-Match" header. If the contact on the server has been modified since you retrieved it (and the ETag on the server has changed), then the CreateContact will fail with an HTTP Protocol Error: "409 Conflict", which indicates there is a conflict between the version you're trying to update and the current version on the sever. For instance: cardDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";

This property is not available at design time.

Data Type

String

ParsedHeaders Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksHeader>* GetParsedHeaders();

int ipworks_carddav_getparsedheadercount(void* lpObj);

char* ipworks_carddav_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* ipworks_carddav_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

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.

This property is read-only and not available at design time.

Data Type

IPWorksHeader

Password Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworks_carddav_getpassword(void* lpObj);
int ipworks_carddav_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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.

Data Type

String

PhoneNumbers Property (CardDAV Class)

The telephone number of a contact.

Syntax

• C++
• C
• Qt

IPWorksList<IPWorksCardCustomProp>* GetPhoneNumbers();
int SetPhoneNumbers(IPWorksList<IPWorksCardCustomProp>* val);

int ipworks_carddav_getphonenumbercount(void* lpObj);
int ipworks_carddav_setphonenumbercount(void* lpObj, int iPhoneNumberCount);

char* ipworks_carddav_getphonenumberattribute(void* lpObj, int phonenumberindex);
int ipworks_carddav_setphonenumberattribute(void* lpObj, int phonenumberindex, const char* lpszPhoneNumberAttribute);

char* ipworks_carddav_getphonenumbername(void* lpObj, int phonenumberindex);
int ipworks_carddav_setphonenumbername(void* lpObj, int phonenumberindex, const char* lpszPhoneNumberName);

char* ipworks_carddav_getphonenumbervalue(void* lpObj, int phonenumberindex);
int ipworks_carddav_setphonenumbervalue(void* lpObj, int phonenumberindex, const char* lpszPhoneNumberValue);

int GetPhoneNumberCount();
int SetPhoneNumberCount(int iPhoneNumberCount);

QString GetPhoneNumberAttribute(int iPhoneNumberIndex);
int SetPhoneNumberAttribute(int iPhoneNumberIndex, QString qsPhoneNumberAttribute);

QString GetPhoneNumberName(int iPhoneNumberIndex);
int SetPhoneNumberName(int iPhoneNumberIndex, QString qsPhoneNumberName);

QString GetPhoneNumberValue(int iPhoneNumberIndex);
int SetPhoneNumberValue(int iPhoneNumberIndex, QString qsPhoneNumberValue);

Remarks

This property is used to specify one or more telephone numbers associated with a contact. Each phone number consists of a single text value and can include parameters such as TYPE to specify the type of telephone number (e.g., home, msg, voice, fax, cell, video, pager, bbs, modem, car isdn, pcs etc.). Below is an example on how to use this property: CardCustomProp phoneNumber = new CardCustomProp("phone number", "+1-213-555-1234"); phoneNumber.Attribute = "TYPE=home,voice"; //optional cardDAV.PhoneNumbers.Add(phoneNumber); phoneNumber = new CardCustomProp("phone number", "+1-789-666-4321"); phoneNumber.Attribute = "TYPE=work,voice,pref,msg"; //optional cardDAV.PhoneNumbers.Add(phoneNumber);

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

Photo Property (CardDAV Class)

A photograph or image associated with a contact.

Syntax

• C++
• C
• Qt

IPWorksCardCustomProp* GetPhoto();
int SetPhoto(IPWorksCardCustomProp* val);

char* ipworks_carddav_getphotoattribute(void* lpObj);
int ipworks_carddav_setphotoattribute(void* lpObj, const char* lpszPhotoAttribute);

char* ipworks_carddav_getphotoname(void* lpObj);
int ipworks_carddav_setphotoname(void* lpObj, const char* lpszPhotoName);

char* ipworks_carddav_getphotovalue(void* lpObj);
int ipworks_carddav_setphotovalue(void* lpObj, const char* lpszPhotoValue);

QString GetPhotoAttribute();
int SetPhotoAttribute(QString qsPhotoAttribute);

QString GetPhotoName();
int SetPhotoName(QString qsPhotoName);

QString GetPhotoValue();
int SetPhotoValue(QString qsPhotoValue);

Remarks

This property is used to specify a photograph or image associated with a contact. Its value can be either a URI pointing to the location of the photograph/image or an inline binary representation of the image data. When using inline binary representation, the encoding must be reset to "b" using the ENCODING parameter. Below is an example on how to use this property: CardCustomProp photo = new CardCustomProp("photo", "http://www.abc.com/pub/photos/jqpublic.gif"); //or //CardCustomProp photo = new CardCustomProp("photo", "MIICajCCAdOgAwIBAgICBEUwDQYJ...QQLExNJbmZvcm1hdGlvbiBTeXN0"); //photo.Attribute = "ENCODING=b;TYPE=JPEG"; cardDAV.Photo = photo;

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

IPWorksCardCustomProp

Proxy Property (CardDAV Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksProxy* GetProxy();
int SetProxy(IPWorksProxy* val);

int ipworks_carddav_getproxyauthscheme(void* lpObj);
int ipworks_carddav_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworks_carddav_getproxyautodetect(void* lpObj);
int ipworks_carddav_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworks_carddav_getproxypassword(void* lpObj);
int ipworks_carddav_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworks_carddav_getproxyport(void* lpObj);
int ipworks_carddav_setproxyport(void* lpObj, int iProxyPort);

char* ipworks_carddav_getproxyserver(void* lpObj);
int ipworks_carddav_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworks_carddav_getproxyssl(void* lpObj);
int ipworks_carddav_setproxyssl(void* lpObj, int iProxySSL);

char* ipworks_carddav_getproxyuser(void* lpObj);
int ipworks_carddav_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

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

Data Type

IPWorksProxy

ReportFilter Property (CardDAV Class)

Criteria used to filter reports.

Syntax

• C++
• C
• Qt

IPWorksCardReportFilter* GetReportFilter();
int SetReportFilter(IPWorksCardReportFilter* val);

char* ipworks_carddav_getreportfiltercustomfilter(void* lpObj);
int ipworks_carddav_setreportfiltercustomfilter(void* lpObj, const char* lpszReportFilterCustomFilter);

char* ipworks_carddav_getreportfilterproperty(void* lpObj);
int ipworks_carddav_setreportfilterproperty(void* lpObj, const char* lpszReportFilterProperty);

int ipworks_carddav_getreportfilterreturncontactdata(void* lpObj);
int ipworks_carddav_setreportfilterreturncontactdata(void* lpObj, int bReportFilterReturnContactData);

char* ipworks_carddav_getreportfilteruid(void* lpObj);
int ipworks_carddav_setreportfilteruid(void* lpObj, const char* lpszReportFilterUID);

QString GetReportFilterCustomFilter();
int SetReportFilterCustomFilter(QString qsReportFilterCustomFilter);

QString GetReportFilterProperty();
int SetReportFilterProperty(QString qsReportFilterProperty);

bool GetReportFilterReturnContactData();
int SetReportFilterReturnContactData(bool bReportFilterReturnContactData);

QString GetReportFilterUID();
int SetReportFilterUID(QString qsReportFilterUID);

Remarks

This property may be used to restrict the results of reports to only those that match your search criteria.The GetAddressbookReport method will normally return the entire address book collection at the specified ResourceURI. You can restrict results to only contacts within a specified criteria. You can restrict results to only those contacts which contain a specific Property (either by property name, or name and a specific value). You can use CustomFilter to specify a properly-formed XML which a contact has to match. To find a specific contact you can use the UID and the result of the report will contain only the contact with that UID or no contacts if none match. You can use ReturnContactData to decide whether the contents of each contact are returned in the report. Below is an example on how to use this property: // cardDAV.ReportFilter.UID = "734D516F-932B-45BD"; // the report will contain only one contact, the one that has the specified UID // cardDAV.ReportFilter.Property = "FN:Abby,ORG:CompanyName"; // the report will contain contacts that have the Formatted Name equals to "Abby" and Organization equals to "CompanyName" cardDAV.ReportFilter.ReturnContactData = false; //the report will contain only URIs and ETags of each contact. cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/AddressbookName");

Data Type

IPWorksCardReportFilter

Role Property (CardDAV Class)

The function or part played in a particular situation by a contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRole();
int SetRole(const char* lpszRole);

Unicode (Windows)
LPWSTR GetRole();
INT SetRole(LPCWSTR lpszRole);

char* ipworks_carddav_getrole(void* lpObj);
int ipworks_carddav_setrole(void* lpObj, const char* lpszRole);

QString GetRole();
int SetRole(QString qsRole);

Default Value

""

Remarks

The value of this property should be a single text value representing the role of the contact. This property provides additional contextual information about the contact's position within an organization or their function in a specific context.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

SSLAcceptServerCert Property (CardDAV Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_carddav_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_carddav_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_carddav_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_carddav_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_carddav_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_carddav_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_carddav_getsslacceptservercertissuer(void* lpObj);

char* ipworks_carddav_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_carddav_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_carddav_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_carddav_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_carddav_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_carddav_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_carddav_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_carddav_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_carddav_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_carddav_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_carddav_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_carddav_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_carddav_getsslacceptservercertstoretype(void* lpObj);
int ipworks_carddav_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_carddav_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_carddav_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_carddav_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_carddav_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_carddav_getsslacceptservercertusage(void* lpObj);

int ipworks_carddav_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_carddav_getsslacceptservercertversion(void* lpObj);

char* ipworks_carddav_getsslacceptservercertsubject(void* lpObj);
int ipworks_carddav_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_carddav_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_carddav_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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.

Data Type

IPWorksCertificate

SSLCert Property (CardDAV Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_carddav_getsslcerteffectivedate(void* lpObj);

char* ipworks_carddav_getsslcertexpirationdate(void* lpObj);

char* ipworks_carddav_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_carddav_getsslcertfingerprint(void* lpObj);

char* ipworks_carddav_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_carddav_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_carddav_getsslcertissuer(void* lpObj);

char* ipworks_carddav_getsslcertprivatekey(void* lpObj);

int ipworks_carddav_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_carddav_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_carddav_getsslcertpublickey(void* lpObj);

char* ipworks_carddav_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_carddav_getsslcertpublickeylength(void* lpObj);

char* ipworks_carddav_getsslcertserialnumber(void* lpObj);

char* ipworks_carddav_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_carddav_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_carddav_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_carddav_getsslcertstorepassword(void* lpObj);
int ipworks_carddav_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_carddav_getsslcertstoretype(void* lpObj);
int ipworks_carddav_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_carddav_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_carddav_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_carddav_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_carddav_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_carddav_getsslcertusage(void* lpObj);

int ipworks_carddav_getsslcertusageflags(void* lpObj);

char* ipworks_carddav_getsslcertversion(void* lpObj);

char* ipworks_carddav_getsslcertsubject(void* lpObj);
int ipworks_carddav_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_carddav_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_carddav_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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 Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksCertificate

SSLProvider Property (CardDAV Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworks_carddav_getsslprovider(void* lpObj);
int ipworks_carddav_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (CardDAV Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_carddav_getsslservercerteffectivedate(void* lpObj);

char* ipworks_carddav_getsslservercertexpirationdate(void* lpObj);

char* ipworks_carddav_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_carddav_getsslservercertfingerprint(void* lpObj);

char* ipworks_carddav_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_carddav_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_carddav_getsslservercertissuer(void* lpObj);

char* ipworks_carddav_getsslservercertprivatekey(void* lpObj);

int ipworks_carddav_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_carddav_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_carddav_getsslservercertpublickey(void* lpObj);

char* ipworks_carddav_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_carddav_getsslservercertpublickeylength(void* lpObj);

char* ipworks_carddav_getsslservercertserialnumber(void* lpObj);

char* ipworks_carddav_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_carddav_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_carddav_getsslservercertstorepassword(void* lpObj);

int ipworks_carddav_getsslservercertstoretype(void* lpObj);

char* ipworks_carddav_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_carddav_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_carddav_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_carddav_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_carddav_getsslservercertusage(void* lpObj);

int ipworks_carddav_getsslservercertusageflags(void* lpObj);

char* ipworks_carddav_getsslservercertversion(void* lpObj);

char* ipworks_carddav_getsslservercertsubject(void* lpObj);

int ipworks_carddav_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

Timeout Property (CardDAV Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworks_carddav_gettimeout(void* lpObj);
int ipworks_carddav_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 fails with an error.

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.

Data Type

Integer

Title Property (CardDAV Class)

The position or job of the object the vCard represents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTitle();
int SetTitle(const char* lpszTitle);

Unicode (Windows)
LPWSTR GetTitle();
INT SetTitle(LPCWSTR lpszTitle);

char* ipworks_carddav_gettitle(void* lpObj);
int ipworks_carddav_settitle(void* lpObj, const char* lpszTitle);

QString GetTitle();
int SetTitle(QString qsTitle);

Default Value

""

Remarks

This property is used to specify the position or job of the object the vCard represents. Its value should be a single text value representing the title or honorific prefix of the contact.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

UID Property (CardDAV Class)

A persistent, globally unique identifier for the contact.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUID();
int SetUID(const char* lpszUID);

Unicode (Windows)
LPWSTR GetUID();
INT SetUID(LPCWSTR lpszUID);

char* ipworks_carddav_getuid(void* lpObj);
int ipworks_carddav_setuid(void* lpObj, const char* lpszUID);

QString GetUID();
int SetUID(QString qsUID);

Default Value

""

Remarks

The value of the UID property should be a single text value that uniquely identifies a contact. This identifier remains consistent across modifications and updates to the contact, ensuring stable reference and synchronization. To generate a UID you can generate an ID based on a combination of timestamp and a random value or just a timestamp.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

URL Property (CardDAV Class)

Location of the contact resource on the CardDAV server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();

Unicode (Windows)
LPWSTR GetURL();

char* ipworks_carddav_geturl(void* lpObj);

QString GetURL();

Default Value

""

Remarks

This property is read-only, and will be filled with the location of the contact resource for each contact returned. This will only be returned in response to GetAddressbookReport.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

This property is read-only.

Data Type

String

User Property (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworks_carddav_getuser(void* lpObj);
int ipworks_carddav_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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.

Data Type

String

VCardVersion Property (CardDAV Class)

The vCard version format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVCardVersion();
int SetVCardVersion(const char* lpszVCardVersion);

Unicode (Windows)
LPWSTR GetVCardVersion();
INT SetVCardVersion(LPCWSTR lpszVCardVersion);

char* ipworks_carddav_getvcardversion(void* lpObj);
int ipworks_carddav_setvcardversion(void* lpObj, const char* lpszVCardVersion);

QString GetVCardVersion();
int SetVCardVersion(QString qsVCardVersion);

Default Value

""

Remarks

This property is used to specify the version of the vCard specification used to format this vCard. Its value should be a single text value indicating the version of the vCard format being used. Typically, this value will be "3.0" or "4.0" to denote the version of the vCard specification adhered to.

This property is filled from the response to a GetContact, and is also used when creating a contact to be added using the CreateContact method. However, when requesting a report using the GetAddressbookReport method, the contents of this property will only be valid inside the ContactDetails event.

Data Type

String

AddCookie Method (CardDAV Class)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworks_carddav_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

This method 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddCustomProperty Method (CardDAV Class)

Adds a form variable and the corresponding value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCustomProperty(const char* lpszVarName, const char* lpszVarValue);

Unicode (Windows)
INT AddCustomProperty(LPCWSTR lpszVarName, LPCWSTR lpszVarValue);

int ipworks_carddav_addcustomproperty(void* lpObj, const char* lpszVarName, const char* lpszVarValue);

int AddCustomProperty(const QString& qsVarName, const QString& qsVarValue);

Remarks

This property adds a form variable and the corresponding value. For information on form variables and how they are managed, please refer to the CustomProperties properties.

Example using the AddCustomProperty method:

CardDAV.Reset() CardDAV.AddCustomProperty("propname1", "propvalue1") CardDAV.AddCustomProperty("propname2", "propvalue2") Example using Custom Property arrays: CardDAV.Reset() CardDAV.CustomPropertyCount = 2 CardDAV.CustomPropertyName (0) = "propname1" CardDAV.CustomPropertyValue(0) = "propvalue1" CardDAV.CustomPropertyName (1) = "propname2" CardDAV.CustomPropertyValue(1) = "propvalue2"

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (CardDAV Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_carddav_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyContact Method (CardDAV Class)

Copy contact to a new location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyContact(const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

Unicode (Windows)
INT CopyContact(LPCWSTR lpszSourceResourceURI, LPCWSTR lpszDestinationResourceURI);

int ipworks_carddav_copycontact(void* lpObj, const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

int CopyContact(const QString& qsSourceResourceURI, const QString& qsDestinationResourceURI);

Remarks

The CopyContact method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

Note that neither Yahoo nor Google CardDAV servers support copying, or moving address book resources.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateAddressbook Method (CardDAV Class)

Creates a new address book collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateAddressbook(const char* lpszResourceURI, const char* lpszDisplayName, const char* lpszDescription);

Unicode (Windows)
INT CreateAddressbook(LPCWSTR lpszResourceURI, LPCWSTR lpszDisplayName, LPCWSTR lpszDescription);

int ipworks_carddav_createaddressbook(void* lpObj, const char* lpszResourceURI, const char* lpszDisplayName, const char* lpszDescription);

int CreateAddressbook(const QString& qsResourceURI, const QString& qsDisplayName, const QString& qsDescription);

Remarks

The CreateAddressbook method creates a new address book collection resource. A server MAY restrict address book collection creation to particular collections.

Creating address book collections is not supported by all CardDAV servers. Some address book stores only support one address book per user (or principal), and those are typically pre-created for each account.

The DisplayName and Description parameters should be set to a human readable display name and description of the address book.

To successfully create an address book, the ResourceURI cannot already exist, and must point to a valid location where a new address book can be created. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to create a simple new address book collection resource. cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", "My Display Name", "My Addressbook Description");

Note that Google does not support creating a new address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateContact Method (CardDAV Class)

Adds a contact resource at the specified ResourceURI using the CardDAV PUT method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateContact(const char* lpszResourceURI);

Unicode (Windows)
INT CreateContact(LPCWSTR lpszResourceURI);

int ipworks_carddav_createcontact(void* lpObj, const char* lpszResourceURI);

int CreateContact(const QString& qsResourceURI);

Remarks

This method adds a new contact to the address book collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CardDAV server to which this contact will be saved. If the ResourceURI already exists, the contact at that URI will be overwritten.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteAddressbook Method (CardDAV Class)

Deletes an address book collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteAddressbook(const char* lpszResourceURI);

Unicode (Windows)
INT DeleteAddressbook(LPCWSTR lpszResourceURI);

int ipworks_carddav_deleteaddressbook(void* lpObj, const char* lpszResourceURI);

int DeleteAddressbook(const QString& qsResourceURI);

Remarks

This method deletes an address book collection resource specified by ResourceURI. To successfully delete an address book, the ResourceURI should already exist, and must point to a valid location where an address book can be deleted. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to delete an address book collection resource: cardDAV.DeleteAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1"); In a NextCloud server, if all address books are deleted, a new address book "Contacts" is automatically created.

Note that Google does not support deleting an address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteContact Method (CardDAV Class)

Deletes a resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteContact(const char* lpszResourceURI);

Unicode (Windows)
INT DeleteContact(LPCWSTR lpszResourceURI);

int ipworks_carddav_deletecontact(void* lpObj, const char* lpszResourceURI);

int DeleteContact(const QString& qsResourceURI);

Remarks

This method is used to delete the resource specified by ResourceURI. ResourceURI is first removed from any collection in which it is contained, it is then removed from the server.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (CardDAV Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_carddav_doevents(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExportVCF Method (CardDAV Class)

Generates a contact from the properties in the vCard format.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ExportVCF();

Unicode (Windows)
LPWSTR ExportVCF();

char* ipworks_carddav_exportvcf(void* lpObj);

QString ExportVCF();

Remarks

The ExportVCF method is used to create a contact and export it in the vCard/VCF format, which can then be saved to disk and imported using any other software, even those that do not support CardDAV. The ExportVCF method will create the exact same data as the CreateContact method sends when adding or updating a contact to an address book.

Note that if ExportVCF is called immediately after a successful GetContact, the unmodified data returned from the CardDAV server will be returned. However if any properties are changed between the GetContact and ExportVCF calls, the class will generate and return a brand new contact.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetAddressbookOptions Method (CardDAV Class)

Retrieves options for the ResourceURI to determine whether it supports address book access.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAddressbookOptions(const char* lpszResourceURI);

Unicode (Windows)
INT GetAddressbookOptions(LPCWSTR lpszResourceURI);

int ipworks_carddav_getaddressbookoptions(void* lpObj, const char* lpszResourceURI);

int GetAddressbookOptions(const QString& qsResourceURI);

Remarks

This method sends a request to the indicated ResourceURI. The server's response is available in the Header event. If a server supports CardDAV address book access, the "DAV" header will contain the string "address book". The allowable CardDAV and WebDAV methods may also be returned in the "Allow" header.

For instance, the following headers may be returned from a call to the GetAddressbookOptions method:

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAddressbookReport Method (CardDAV Class)

Generates a report on the indicated address book.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAddressbookReport(const char* lpszResourceURI);

Unicode (Windows)
INT GetAddressbookReport(LPCWSTR lpszResourceURI);

int ipworks_carddav_getaddressbookreport(void* lpObj, const char* lpszResourceURI);

int GetAddressbookReport(const QString& qsResourceURI);

Remarks

This method is used to send a request to the address book located at the specified ResourceURI. The ReportFilter can be used to filter out and return only the contacts you wish to receive. The response to an addressbook-query report will be parsed by the class, and information about the individual contacts will be provided in the ContactDetails event.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

For example: cardDAV.User = "myusername"; cardDAV.Password = "mypassword"; cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/user@gmail.com/lists/default"); The following code inside the ContactDetails event will print the formatted name, phone number and email for each contact: Private Sub CardDAV_ContactDetails(ResourceURI As String, ResponseStatus As String, ETag As String, ContactData As String) Debug.Print cardDAV.FormattedName + " " + cardDAV.PhoneNumbers[0].Value + " " + cardDAV.EMails[0].Value End Sub The output from the above code will look like this:

John Smith  123-456-7890  john@example.com
Jane Doe  555-555-5555  jane@example.com
Alice Johnson 987-654-3210  alice@example.com 

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetContact Method (CardDAV Class)

Retrieves a single contact from the CardDAV server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContact(const char* lpszResourceURI);

Unicode (Windows)
INT GetContact(LPCWSTR lpszResourceURI);

int ipworks_carddav_getcontact(void* lpObj, const char* lpszResourceURI);

int GetContact(const QString& qsResourceURI);

Remarks

This method retrieves a single contact from a server. The ResourceURI points to the exact location of the vCard (*.vcf) file you wish to retrieve. (If you do not know the URL of the contact you need, you can use GetAddressbookReport along with the ReportFilter property to find it.)

The contact will be retrieved using the WebDAV GET method. The full response is delivered through the Transfer event and the HTTP response headers through the Header event. After a contact is retrieved with this method, the class parses the contact data into properties. You may then edit these properties and use UpdateContact to update the contact resource.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ImportVCF Method (CardDAV Class)

Imports contact data (contained in a VCF file) into the class's property list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ImportVCF(const char* lpszContactData);

Unicode (Windows)
INT ImportVCF(LPCWSTR lpszContactData);

int ipworks_carddav_importvcf(void* lpObj, const char* lpszContactData);

int ImportVCF(const QString& qsContactData);

Remarks

This method is used to load contact data from an external source into the class. You may then submit this data with a call to UpdateContact or CreateContact. If you edit any of the class properties between importing and calling UpdateContact or CreateContact, the class will re-generate the request itself. If no properties are changed, the imported data will be submitted unaltered when calling UpdateContact or CreateContact.

As the contact data is imported, the class will scan ContactData for any contacts. Each time a contact is discovered, the ContactDetails event will fire, and the contact properties will be updated.

After ImportVCF completes, the contact properties will be set to the most recent contact found in ContactData.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (CardDAV Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworks_carddav_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListAddressbooks Method (CardDAV Class)

Lists all address books that the current user can access.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListAddressbooks(const char* lpszbaseURL);

Unicode (Windows)
INT ListAddressbooks(LPCWSTR lpszbaseURL);

int ipworks_carddav_listaddressbooks(void* lpObj, const char* lpszbaseURL);

int ListAddressbooks(const QString& qsbaseURL);

Remarks

This method lists all address books the user can access.

The BaseURL parameter must be set to the base CardDAV URL for the server. For instance in the case of Google this is https://www.googleapis.com/carddav/v1/principals/. Other servers may use a format like https://mydavserver/.well-known/carddav/.

When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get addressbook-home-set for the user. The addressbook-home-set is then used by the class to make a final PROPFIND request to get the list of address books for the user.

Once this method returns, the class will populate the Addressbooks collection. For example:

cardDAV.ListAddressbooks("https://mydavserver/.well-known/carddav/Address_Book_Name"); for (int i = 0; i < cardDAV.Addressbooks.Count; i++) { string url = cardDAV.Addressbooks[i].URL; string displayName = cardDAV.Addressbooks[i].DisplayName; }

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

MoveContact Method (CardDAV Class)

Moves one contact resource to a new location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveContact(const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

Unicode (Windows)
INT MoveContact(LPCWSTR lpszSourceResourceURI, LPCWSTR lpszDestinationResourceURI);

int ipworks_carddav_movecontact(void* lpObj, const char* lpszSourceResourceURI, const char* lpszDestinationResourceURI);

int MoveContact(const QString& qsSourceResourceURI, const QString& qsDestinationResourceURI);

Remarks

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

Note that Google CardDAV servers do not support copying, or moving contacts.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (CardDAV Class)

Reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_carddav_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (CardDAV Class)

Sends a custom request to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszUrl, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszUrl, LPCWSTR lpszRequestBody);

int ipworks_carddav_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszUrl, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsUrl, const QString& qsRequestBody);

Remarks

Allows users to send personalized HTTP commands to a CardDAV server.

Valid values for HttpMethod are:

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

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. Here is an example of how to create a contact: string contactData = @"BEGIN:VCARD PRODID:/n software IPWorks CardDAV Component - www.nsoftware.com UID:20240307T160700Z ANNIVERSARY:19961212 FN:John NICKNAME:John PHOTO:TestURI EMAIL:test@test.com TEL:123456789 END:VCARD"; cardDAV.SendCustomRequest("PUT", "https://mydavserver/.well-known/carddav/AddressbookName/contact.ics", contactData);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateAddressbook Method (CardDAV Class)

Updates an address book collection resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateAddressbook(const char* lpszResourceURI, int iABIndex);

Unicode (Windows)
INT UpdateAddressbook(LPCWSTR lpszResourceURI, INT iABIndex);

int ipworks_carddav_updateaddressbook(void* lpObj, const char* lpszResourceURI, int iABIndex);

int UpdateAddressbook(const QString& qsResourceURI, int iABIndex);

Remarks

This method updates an existing address book collection at the specified ResourceURI. To successfully update an address book, the ResourceURI should already exist, and must point to a valid location where an address book is saved. First iterate through Addressbooks to find the index of the address book to be updated. Set the properties of the address book to the desired values and then make a call to UpdateAddressbook.

The following example shows how to update an address book collection resource: cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", "display_name", "description"); cardDAV.Addressbooks[0].DisplayName = "display_name_updated"; cardDAV.Addressbooks[0].Description = "description_updated"; cardDAV.UpdateAddressbook("https://mydavserver/.well-known/carddav/TestAddressbook1", 0);

Note that Google does not support updating an address book through CardDAV.

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateContact Method (CardDAV Class)

Updates a contact at the specified ResourceURI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateContact(const char* lpszResourceURI);

Unicode (Windows)
INT UpdateContact(LPCWSTR lpszResourceURI);

int ipworks_carddav_updatecontact(void* lpObj, const char* lpszResourceURI);

int UpdateContact(const QString& qsResourceURI);

Remarks

This method updates an existing contact to the address book collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CardDAV server to which this contact is saved.

The following properties are used when calling CreateContact, UpdateContact or ExportVCF, and will be filled after calling GetContact or ImportVCF. These will also be available from inside the ContactDetails event, which is fired for each contact received from the CardDAV server in response when calling GetAddressbookReport.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

There is no standard format for a resource URI. Google for instance, uses "https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default" address to access the default address book. Here is an example of using the GetAddressbookReport, that makes a REPORT request to the given URI in the CardDAV server. cardDAV.GetAddressbookReport("https://www.googleapis.com/carddav/v1/principals/username@gmail.com/lists/default");

Generally, the URI format would be something like "https://mydavserver/.well-known/carddav/Address_Book_Name". To add, delete, update, copy or move a contact from an address book, you can add its file name at the end of the address book URI, which typically has a vcf extension (not always). Usually the filename of a contact would be the same as the UID of the contact plus the vcf extension, but this depends on the way the CardDAV server manages resources. This is the resource URI you must use to retrieve the contact with GetContact. For example: cardDAV.GetContact("https://mydavserver/.well-known/carddav/Address_Book_Name/1234567890.vcf");

The examples below show a few possible transactions: cardDAV.User = "username"; cardDAV.Password = "password"; cardDAV.CreateAddressbook("https://mydavserver/.well-known/carddav/Address_Book_Name/", "My Address book", "My Address books"); cardDAV.FormattedName = "Mr. John Q. Public\, Esq."; cardDAV.PhoneNumbers.Add(new CardCustomProp("tel", "123456790")); cardDAV.CreateContact("https://mydavserver/.well-known/carddav/Address_Book_Name/123456789.vcf"); cardDAV.GetAddressbookReport("https://mydavserver/.well-known/carddav/Address_Book_Name/"); NextCloud's ResourceURIs always start with "http://www.nextcloud.com/remote.php/dav/addressbooks/users/" plus your user name, plus the name of your address book. For instance: "http://www.nextcloud.com/remote.php/dav/addressbooks/users/username/Contacts" for the default address book. Contact resources are located directly under the "username/Contacts" or "username/My_Addressbook" path. Here the filename doesn't have to be identical to the UID.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (CardDAV Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(CardDAVConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} CardDAVConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(CardDAVConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CardDAVConnectedEventParams;

#define EID_CARDDAV_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class CardDAVConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(CardDAVConnectedEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireConnected(CardDAVConnectedEventParams *e) {...}

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 (CardDAV Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(CardDAVConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} CardDAVConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(CardDAVConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CardDAVConnectionStatusEventParams;

#define EID_CARDDAV_CONNECTIONSTATUS 2

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class CardDAVConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(CardDAVConnectionStatusEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireConnectionStatus(CardDAVConnectionStatusEventParams *e) {...}

Remarks

This 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:

ContactDetails Event (CardDAV Class)

Fires for each contact received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireContactDetails(CardDAVContactDetailsEventParams *e);

typedef struct {
  const char *ResourceURI;
  const char *ResponseStatus;
  const char *ETag;
  const char *ContactData;
  int reserved;
} CardDAVContactDetailsEventParams;


Unicode (Windows)
virtual INT FireContactDetails(CardDAVContactDetailsEventParams *e);

typedef struct {
  LPCWSTR ResourceURI;
  LPCWSTR ResponseStatus;
  LPCWSTR ETag;
  LPCWSTR ContactData;
  INT reserved;
} CardDAVContactDetailsEventParams;

#define EID_CARDDAV_CONTACTDETAILS 3

virtual INT IPWORKS_CALL FireContactDetails(LPSTR &lpszResourceURI, LPSTR &lpszResponseStatus, LPSTR &lpszETag, LPSTR &lpszContactData);

class CardDAVContactDetailsEventParams {
public:
  const QString &ResourceURI();

  const QString &ResponseStatus();

  const QString &ETag();

  const QString &ContactData();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ContactDetails(CardDAVContactDetailsEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireContactDetails(CardDAVContactDetailsEventParams *e) {...}

Remarks

This event fires for each VCARD contact received in response to a GetAddressbookReport request. The ResourceURI parameter indicates the location of this particular contact on the CardDAV server, and the ETag parameter is used to indicate the current state of the contact. If the ETag is different from the value you have cached for the current ResourceURI, it means the contact has changed on the server since the last time you updated your cache. ResponseStatus indicates the HTTP status of CardDAV server received when attempting to retrieve this particular ResourceURI when it was building the report. The ContactData parameter contains the raw contact entry as returned by the CardDAV server. This data is also parsed into the following properties, and are valid for the current ResourceURI only inside this event.

• AddressLabels
• Addresses
• Agent
• Anniversary
• BirthDay
• Categories
• Classification
• ContactURL
• CustomProperties
• Depth
• EMails
• FormattedName
• Gender
• GeoLocation
• IMPPs
• Kind
• Languages
• Logo
• Mailer
• Member
• Names
• NickName
• Note
• Organization
• PhoneNumbers
• Photo
• ProductId
• PublicKey
• Related
• RevisionTime
• Role
• SortString
• Sound
• Timezone
• Title
• UID
• URL
• VCardVersion
• XML

Note that for a large address book you may not wish to return the full contents of each contact, as this could be a substantially large amount of data. In this case, set the ReturnContactData field to false, and only the ResourceURI, ResponseStatus, and ETag parameters will be returned by the CardDAV server for each contact. The contents of the contact will not be returned, and the ContactData parameter will be empty.

Disconnected Event (CardDAV Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(CardDAVDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} CardDAVDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(CardDAVDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CardDAVDisconnectedEventParams;

#define EID_CARDDAV_DISCONNECTED 4

virtual INT IPWORKS_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class CardDAVDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(CardDAVDisconnectedEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireDisconnected(CardDAVDisconnectedEventParams *e) {...}

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 (CardDAV Class)

This event is fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(CardDAVEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} CardDAVEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(CardDAVEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} CardDAVEndTransferEventParams;

#define EID_CARDDAV_ENDTRANSFER 5

virtual INT IPWORKS_CALL FireEndTransfer(INT &iDirection);

class CardDAVEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(CardDAVEndTransferEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireEndTransfer(CardDAVEndTransferEventParams *e) {...}

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 (CardDAV Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(CardDAVErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} CardDAVErrorEventParams;


Unicode (Windows)
virtual INT FireError(CardDAVErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} CardDAVErrorEventParams;

#define EID_CARDDAV_ERROR 6

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class CardDAVErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(CardDAVErrorEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireError(CardDAVErrorEventParams *e) {...}

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter 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 (CardDAV Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(CardDAVHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} CardDAVHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(CardDAVHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} CardDAVHeaderEventParams;

#define EID_CARDDAV_HEADER 7

virtual INT IPWORKS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class CardDAVHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(CardDAVHeaderEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireHeader(CardDAVHeaderEventParams *e) {...}

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 (CardDAV Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(CardDAVLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} CardDAVLogEventParams;


Unicode (Windows)
virtual INT FireLog(CardDAVLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} CardDAVLogEventParams;

#define EID_CARDDAV_LOG 8

virtual INT IPWORKS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class CardDAVLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(CardDAVLogEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireLog(CardDAVLogEventParams *e) {...}

Remarks

This event is fired 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 (CardDAV Class)

Fired when a redirection is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRedirect(CardDAVRedirectEventParams *e);

typedef struct {
  const char *Location;
  int Accept;
  int reserved;
} CardDAVRedirectEventParams;


Unicode (Windows)
virtual INT FireRedirect(CardDAVRedirectEventParams *e);

typedef struct {
  LPCWSTR Location;
  BOOL Accept;
  INT reserved;
} CardDAVRedirectEventParams;

#define EID_CARDDAV_REDIRECT 9

virtual INT IPWORKS_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

class CardDAVRedirectEventParams {
public:
  const QString &Location();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Redirect(CardDAVRedirectEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireRedirect(CardDAVRedirectEventParams *e) {...}

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 fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (CardDAV Class)

Fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(CardDAVSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} CardDAVSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(CardDAVSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} CardDAVSetCookieEventParams;

#define EID_CARDDAV_SETCOOKIE 10

virtual INT IPWORKS_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

class CardDAVSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetCookie(CardDAVSetCookieEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireSetCookie(CardDAVSetCookieEventParams *e) {...}

Remarks

This 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 (CardDAV Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(CardDAVSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} CardDAVSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(CardDAVSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} CardDAVSSLServerAuthenticationEventParams;

#define EID_CARDDAV_SSLSERVERAUTHENTICATION 11

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class CardDAVSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(CardDAVSSLServerAuthenticationEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireSSLServerAuthentication(CardDAVSSLServerAuthenticationEventParams *e) {...}

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 (CardDAV Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(CardDAVSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} CardDAVSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(CardDAVSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} CardDAVSSLStatusEventParams;

#define EID_CARDDAV_SSLSTATUS 12

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszMessage);

class CardDAVSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(CardDAVSSLStatusEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireSSLStatus(CardDAVSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (CardDAV Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(CardDAVStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} CardDAVStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(CardDAVStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} CardDAVStartTransferEventParams;

#define EID_CARDDAV_STARTTRANSFER 13

virtual INT IPWORKS_CALL FireStartTransfer(INT &iDirection);

class CardDAVStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(CardDAVStartTransferEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireStartTransfer(CardDAVStartTransferEventParams *e) {...}

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 (CardDAV Class)

Fired when the HTTP status line is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(CardDAVStatusEventParams *e);

typedef struct {
  const char *HTTPVersion;
  int StatusCode;
  const char *Description;
  int reserved;
} CardDAVStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(CardDAVStatusEventParams *e);

typedef struct {
  LPCWSTR HTTPVersion;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} CardDAVStatusEventParams;

#define EID_CARDDAV_STATUS 14

virtual INT IPWORKS_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);

class CardDAVStatusEventParams {
public:
  const QString &HTTPVersion();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(CardDAVStatusEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireStatus(CardDAVStatusEventParams *e) {...}

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 (CardDAV Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(CardDAVTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} CardDAVTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(CardDAVTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} CardDAVTransferEventParams;

#define EID_CARDDAV_TRANSFER 15

virtual INT IPWORKS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class CardDAVTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(CardDAVTransferEventParams *e);

// Or, subclass CardDAV and override this emitter function.
virtual int FireTransfer(CardDAVTransferEventParams *e) {...}

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.

CardAddressbookInfo Type

Contains the details of an address book.

Syntax

IPWorksCardAddressbookInfo (declared in ipworks.h)

Remarks

This type contains the details of an address book.

Fields

Constructors

CardAddressbookInfo()

CardCustomProp Type

Name/Value pair of custom properties to add to the request.

Syntax

IPWorksCardCustomProp (declared in ipworks.h)

Remarks

This type describes a form variable that is to be posted to the Resource URI when Putting a contact or creating a new address book. The type contains fields which describe this variable's name, value, and attribute.

Fields

Constructors

CardCustomProp()

CardCustomProp(const char* lpszName, const char* lpszValue)

CardCustomProp(const char* lpszName, const char* lpszValue, const char* lpszAttribute)

CardReportFilter Type

Used to restrict the results of a Report returned from the CardDAV server.

Syntax

IPWorksCardReportFilter (declared in ipworks.h)

Remarks

You can restrict results to only contacts within a specified criteria. You can restrict results to only those events which contain a specific Property (either by property name, or name and a specific value). The CustomFilter can be used to specify a XML to filter the contacts. The UID can be used to filter contacts with a specific UID, which would lead to only one contact being received, because contacts have unique UIDs.

Fields

Constructors

CardReportFilter()

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

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