WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIAbListener

IID:b3ca8745-2dad-4032-ae2f-0b8622f32697
Inherits From:nsISupports

Implement this interface to receive notifications of address book items being added, removed or changed with loaded address books.

Subscribe to events by using nsIAbManager.

This interface is implemented by the following components:

Constants

An address book, mailing list or card is added.
abListenerNotifyFlagValue itemAdded = 1
A mailing list or card is removed from an address book.
abListenerNotifyFlagValue directoryItemRemoved = 2
An address book is removed
abListenerNotifyFlagValue directoryRemoved = 4
An address book, mailing list or card is changed.
abListenerNotifyFlagValue itemChanged = 8
All of the above notifications are to be received.
abListenerNotifyFlagValue all = -1

Methods

void onItemAdded ( nsISupports parentDir , nsISupports item ) void onItemPropertyChanged ( nsISupports item , char* property , PRUnichar* oldValue , PRUnichar* newValue ) void onItemRemoved ( nsISupports parentDir , nsISupports item )

void onItemAdded ( nsISupports parentDir , nsISupports item )

Called when an address book item (book, card or list) is added

Arguments:
parentDir: The parent of the item being added.
item: The item being added to the database (a directory or card).

void onItemPropertyChanged ( nsISupports item , char* property , PRUnichar* oldValue , PRUnichar* newValue )

Called when an address book item is changed. Note the current implementation means that property is either the literal string "DirName" or null, with oldValue and newValue being specified if the property is "DirName" otherwise they are null.

Arguments:
item: The item being updated (a directory or a card).
property: The property of the item being changed.
oldValue: The old value of the item property being changed if it is known, null otherwise.
newValue: The new value of the item property being changed.

void onItemRemoved ( nsISupports parentDir , nsISupports item )

Called when an address book, mailing list or card is removed. This is partially configurable when setting up the listener via nsIAddrBookSession

Arguments:
parentDir: The parent of the item being removed, this may be an empty directory in the case of a top level address book.
item: The item being removed from the database.

References

This interface is passed as an argument to the following methods:

nsIAbManager.addAddressBookListener, nsIAbManager.removeAddressBookListener

Reference documentation is generated from Mozilla's source.