nsIAnnotationObserver

From MDC

The nsIAnnotationObserver interface is designed to set and delete annotations. It is an observer for annotation changes.

Contents 1 Method overview 2 Methods 2.1 onPageAnnotationSet() 2.1.1 Parameters 2.2 onItemAnnotationSet() 2.2.1 Parameters 2.3 onPageAnnotationRemoved() 2.3.1 Parameters 2.4 onItemAnnotationRemoved() 2.4.1 Parameters 2.5 See also

nsIAnnotationService is defined in toolkit/components/places/public/nsIAnnotationService.idl. It is scriptable and unfrozen (hasn't changed since Mozilla 1.9).

Inherits from: nsISupports

[edit] Method overview

void onPageAnnotationSet(in nsIURI aPage, in AUTF8String aName);

void onItemAnnotationSet(in long long aItemId, in AUTF8String aName);

void onPageAnnotationRemoved(in nsIURI aPage, in AUTF8String aName);

void onItemAnnotationRemoved(in long long aItemId, in AUTF8String aName);

[edit] Methods

[edit] onPageAnnotationSet()

This method is called when an annotation value is set for a URI. It could be a new annotation, or it could be a new value for an existing annotation.

 void onPageAnnotationSet(
   in nsIURI aPage, 
   in AUTF8String aName
 );

[edit] Parameters

aURI

The URI on which the annotation is to be set.

aName

The annotation name.

[edit] onItemAnnotationSet()

This method is called when an annotation value is set for an item. It could be a new annotation, or it could be a new value for an existing annotation.

 void onItemAnnotationSet(
   in long long aItemId, 
   in AUTF8String aName
 );

[edit] Parameters

aItemId

The item on which the annotation is to be set.

aName

The annotation name.

[edit] onPageAnnotationRemoved()

This method is called when an annotation is deleted for a URI. If aName is empty, then ALL annotations for the given URI have been deleted. This is not called when annotations are expired (normally happens when the app exits).

 void onPageAnnotationRemoved(
   in nsIURI aPage, 
   in AUTF8String aName
 );

[edit] Parameters

aURI

The URI whose annotation is to be deleted.

aName

The annotation name.

[edit] onItemAnnotationRemoved()

This method is called when an annotation is deleted for an item. If aName is empty, then ALL annotations for the given URI have been deleted. This is not called when annotations are expired (normally happens when the app exits).

 void onItemAnnotationRemoved(
   in long long aItemId, 
   in AUTF8String aName
 );

[edit] Parameters

aItemId

The item whose annotation is to be deleted.

aName

The annotation name.

[edit] See also

• Places
• Using the Places annotation service
• Using the Places favicon service
• nsIAnnotationService