nsINavBookmarkObserver

Observer for bookmarks changes.

Methods

onBeginUpdateBatch()

Notifies that a batch transaction has started.
Other notifications will be sent during the batch, but the observer is
guaranteed that onEndUpdateBatch() will be called at its completion.
During a batch the observer should do its best to reduce the work done to
handle notifications, since multiple changes are going to happen in a short
timeframe.

onEndUpdateBatch()

Notifies that a batch transaction has ended.

onItemAdded(aItemId, aParentId, aIndex, aItemType, aURI, aTitle, aDateAdded, aGuid, aParentGuid)

Notifies that an item (any type) was added. Called after the actual
addition took place.
When a new item is created, all the items following it in the same folder
will have their index shifted down, but no additional notifications will
be sent.

Parameters

aItemId	The id of the item that was added.
aParentId	The id of the folder to which the item was added.
aIndex	The item's index in the folder.
aItemType	The type of the added item (see TYPE_* constants below).
aURI	The URI of the added item if it was TYPE_BOOKMARK, null otherwise.
aTitle	The title of the added item.
aDateAdded	The stored date added value, in microseconds from the epoch.
aGuid	The unique ID associated with the item.
aParentGuid	The unique ID associated with the item's parent.

onItemRemoved(aItemId, aParentId, aIndex, aItemType, aURI, aGuid, aParentGuid)

Notifies that an item was removed. Called after the actual remove took
place.
When an item is removed, all the items following it in the same folder
will have their index shifted down, but no additional notifications will
be sent.

Parameters

aItemId	The id of the item that was removed.
aParentId	The id of the folder from which the item was removed.
aIndex	The bookmark's index in the folder.
aItemType	The type of the item to be removed (see TYPE_* constants below).
aURI	The URI of the added item if it was TYPE_BOOKMARK, null otherwise.
aGuid	The unique ID associated with the item.
aParentGuid	The unique ID associated with the item's parent.

onItemChanged(aItemId, aProperty, aIsAnnotationProperty, aNewValue, aLastModified, aItemType, aParentId, aGuid, aParentGuid)

Notifies that an item’s information has changed. This will be called
whenever any attributes like “title” are changed.

@note List of values that may be associated with properties:
aProperty | aNewValue
=====================================================================
cleartime | Empty string (all visits to this item were removed).
title | The new title.
favicon | The “moz-anno” URL of the new favicon.
uri | new URL.
tags | Empty string (tags for this item changed)
dateAdded | PRTime (as string) when the item was first added.
lastModified | PRTime (as string) when the item was last modified.

Parameters

aItemId	The id of the item that was changed.
aProperty	The property which changed. Can be null for the removal of all of the annotations, in this case aIsAnnotationProperty is true.
aIsAnnotationProperty	Whether or not aProperty is the name of an annotation. If true aNewValue is always an empty string.
aNewValue	For certain properties, this is set to the new value of the property (see the list below).
aLastModified	If lastModified changed, this parameter is the new value, otherwise it's set to 0.
aItemType	The type of the item to be removed (see TYPE_* constants below).
aParentId	The id of the folder containing the item.
aGuid	The unique ID associated with the item.
aParentGuid	The unique ID associated with the item's parent.

onItemVisited(aItemId, aVisitId, aTime, aTransitionType, aURI, aParentId, aGuid, aParentGuid)

Notifies that the item was visited. Can be invoked only for TYPE_BOOKMARK
items.

@see onItemChanged with property = “cleartime” for when all visits to an
item are removed.

@note The reported time is the time of the visit that was added, which may
be well in the past since the visit time can be specified. This
means that the visit the observer is told about may not be the most
recent visit for that page.

Parameters

aItemId	The id of the bookmark that was visited.
aVisitId	The id of the visit.
aTime	The time of the visit.
aTransitionType	The transition for the visit. See nsINavHistoryService::TRANSITION_* constants for a list of possible values.
aURI	The nsIURI for this bookmark.
aParentId	The id of the folder containing the item.
aGuid	The unique ID associated with the item.
aParentGuid	The unique ID associated with the item's parent.

onItemMoved(aItemId, aOldParentId, aOldIndex, aNewParentId, aNewIndex, aItemType, aGuid, aOldParentGuid, aNewParentGuid)

Notifies that an item has been moved.

Parameters

aItemId	The id of the item that was moved.
aOldParentId	The id of the old parent.
aOldIndex	The old index inside the old parent.
aNewParentId	The id of the new parent.
aNewIndex	The index inside the new parent.
aItemType	The type of the item to be removed (see TYPE_* constants below).
aGuid	The unique ID associated with the item.
aOldParentGuid	The unique ID associated with the old item's parent.
aNewParentGuid	The unique ID associated with the new item's parent.