remove

Purpose

Uses given parameters to remove an entry from the user's address book.

Signature

remove( contact, callbacks )

Returns

This method does not return anything.

Parameter

Name Description
contact An object containing contact parameters. The object must be W3C Contact API specification compliant. However, certain limitations apply, listed in the save article.
callbacks An object containing two callback methods listed below.

Callbacks object structure

The remove listener's callbacks object can be structured as follows:

1
2
3
4
{
    onSuccess: function (contact) { ... },
    onFailure: function (code, description) { ... }
}

Callback methods

Name Description Return type
onSuccess Passed to notify that the removal process completed without issues. undefined
onFailure Passed to notify that the process could not be completed. It passes an object that contains a description of an error. undefined

Related topics

Contacts
Public API reference
Legal notice | Copyright © 2015 and Confidential to Pegasystems Inc. All rights reserved. | Feedback
Advanced...