DeleteContact Method

Deletes a contact within a Google Contacts feed.

Syntax

gcontacts.deleteContact([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The component will delete the contact, of a Google Contacts feed, specified by ContactEditURL.

Prior to calling DeleteContact, you must specify a ContactETag value so that an "If-Match" header is sent (note this property is set automatically when ContactIndex is set). To ensure that you do not delete a contact that has been changed, set ContactETag to the contact's ETag value. Setting ContactETag to "*", will delete the contact regardless of whether it has been updated or not.

Google usually retains placeholders for deleted contacts for 30 days after deletion; during that time, you can request the placeholders using the showdeleted query parameter. Please reference QueryContacts and AddQueryParam for more information about querying deleted contacts.