Method signatures of the ABClientAPI interface

The ABClientAPI interface provides the following method signatures.

Method

Parameters

Description

isContactDeletable

addressBookUID – The address book unique ID of the contact. For ContactManager, this is the linkID.

Return true either if the contact associated with the AddressBookUID can be deleted or if no contact is associated with AddressBookUID. Return false if the contact cannot be deleted.

mergeContacts

keptContactABUID – The addressBookUID of the contact to be kept.

deletedContactABUID – The addressBookUID of the contact to be deleted.

Merge two contacts that were merged in ContactManager. ContactManager does not send contact data with this method call. It is up to the Guidewire core application to retrieve the data for the kept contact.

pendingCreateApproved

context – An ABClientAPIPendingChangeContext object providing information on the user requesting this change.

Notifies the client system that a pending contact creation it submitted has been approved by ContactManager. The client application can use the information in the context parameter to inform the user who submitted the request that the contact was created. Additionally, the core application can update the sync status of the contact and post an appropriate message.

pendingUpdateApproved

context – An ABClientAPIPendingChangeContext object providing information on the user requesting this change.

Notifies the client system that a pending update it submitted has been approved by ContactManager. The client application can use the information in the context parameter to inform the user who submitted the change that the change was approved. Additionally, the core application can update the sync status of the contact and post an appropriate message.

pendingCreateRejected

context – An ABClientAPIPendingChangeContext object providing information on the user requesting this change.

Notifies the client system that a pending contact creation it submitted has been rejected by ContactManager. The client application can use the information in the context parameter to inform the user who submitted the contact to be created that the creation was rejected. Additionally, the core application can update the sync status of the contact and post an appropriate message.

pendingUpdateRejected

context – An ABClientAPIPendingChangeContext object providing information on the user requesting this change.

Notifies the client system that a pending update it submitted has been rejected by ContactManager. The client application can use the information in the context parameter to inform the user who submitted the change that the change was rejected. Additionally, the core application can update the sync status of the contact and post an appropriate message.

removeContact

addressBookUID – Unique ID of a contact that has been removed in ContactManager.

The contact with this AddressBookUID has been removed in ContactManager. This call does not require that the contact be removed by the Guidewire core application. For example, if the contact is in use by an account, PolicyCenter does not retire it.

updateContact

contactXMLXmlBackedInstance that contains the addressBookUID of the contact and the updates to be made.

Data for this contact has changed in ContactManager. Update the contact by using the data in contactXML.