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.

@mozilla.org/browser/annotation-service;1

This component implements the following interfaces:

Constants

Valid values for aExpiration, which sets the expiration policy for your annotation. The times for the days, weeks and months policies are measured since the last visit date of the page in question. These will not expire so long as the user keeps visiting the page from time to time.
PRUint16 nsIAnnotationService.EXPIRE_SESSION = 0
PRUint16 nsIAnnotationService.EXPIRE_WEEKS = 2
PRUint16 nsIAnnotationService.EXPIRE_MONTHS = 3
PRUint16 nsIAnnotationService.EXPIRE_NEVER = 4
PRUint16 nsIAnnotationService.EXPIRE_WITH_HISTORY = 5
PRUint16 nsIAnnotationService.EXPIRE_DAYS = 6
PRUint16 nsIAnnotationService.TYPE_INT32 = 1
PRUint16 nsIAnnotationService.TYPE_DOUBLE = 2
PRUint16 nsIAnnotationService.TYPE_STRING = 3
PRUint16 nsIAnnotationService.TYPE_BINARY = 4
PRUint16 nsIAnnotationService.TYPE_INT64 = 5

Methods

InterfaceMethod
nsIAnnotationService void addObserver ( nsIAnnotationObserver observer )
nsIAnnotationService void copyItemAnnotations ( PRInt64 sourceItemId , PRInt64 destItemId , PRBool overwriteDest )
nsIAnnotationService void copyPageAnnotations ( nsIURI sourceURI , nsIURI destURI , PRBool overwriteDest )
nsIAnnotationService nsIURI getAnnotationURI ( nsIURI URI , AUTF8String name )
nsIAnnotationService nsIVariant getItemAnnotation ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService void getItemAnnotationBinary ( PRInt64 itemId , AUTF8String name , out arrayof PRUint8 data , out PRUint32 dataLen , out AUTF8String mimeType )
nsIAnnotationService [noscript] double getItemAnnotationDouble ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService void getItemAnnotationInfo ( PRInt64 itemId , AUTF8String name , out PRInt32 flags , out PRUint16 expiration , out AUTF8String mimeType , out PRUint16 type )
nsIAnnotationService [noscript] PRInt32 getItemAnnotationInt32 ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService [noscript] PRInt64 getItemAnnotationInt64 ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService void getItemAnnotationNames ( PRInt64 itemId , out PRUint32 count , out nsIVariant result )
nsIAnnotationService [noscript] AString getItemAnnotationString ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService PRUint16 getItemAnnotationType ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService void getItemsWithAnnotation ( AUTF8String name , out PRUint32 resultCount , out arrayof PRInt64 results )
nsIAnnotationService nsIVariant getPageAnnotation ( nsIURI URI , AUTF8String name )
nsIAnnotationService void getPageAnnotationBinary ( nsIURI URI , AUTF8String name , out arrayof PRUint8 data , out PRUint32 dataLen , out AUTF8String mimeType )
nsIAnnotationService [noscript] double getPageAnnotationDouble ( nsIURI URI , AUTF8String name )
nsIAnnotationService void getPageAnnotationInfo ( nsIURI URI , AUTF8String name , out PRInt32 flags , out PRUint16 expiration , out AUTF8String mimeType , out PRUint16 type )
nsIAnnotationService [noscript] PRInt32 getPageAnnotationInt32 ( nsIURI URI , AUTF8String name )
nsIAnnotationService [noscript] PRInt64 getPageAnnotationInt64 ( nsIURI URI , AUTF8String name )
nsIAnnotationService void getPageAnnotationNames ( nsIURI URI , out PRUint32 count , out nsIVariant result )
nsIAnnotationService [noscript] AString getPageAnnotationString ( nsIURI URI , AUTF8String name )
nsIAnnotationService PRUint16 getPageAnnotationType ( nsIURI URI , AUTF8String name )
nsIAnnotationService void getPagesWithAnnotation ( AUTF8String name , out PRUint32 resultCount , out nsIURI results )
nsIAnnotationService PRBool itemHasAnnotation ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService PRBool pageHasAnnotation ( nsIURI URI , AUTF8String name )
nsIAnnotationService void removeItemAnnotation ( PRInt64 itemId , AUTF8String name )
nsIAnnotationService void removeItemAnnotations ( PRInt64 itemId )
nsIAnnotationService void removeObserver ( nsIAnnotationObserver observer )
nsIAnnotationService void removePageAnnotation ( nsIURI URI , AUTF8String name )
nsIAnnotationService void removePageAnnotations ( nsIURI URI )
nsIAnnotationService void setItemAnnotation ( PRInt64 itemId , AUTF8String name , nsIVariant value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService void setItemAnnotationBinary ( PRInt64 itemId , AUTF8String name , arrayof PRUint8 data , PRUint32 dataLen , AUTF8String mimeType , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setItemAnnotationDouble ( PRInt64 itemId , AUTF8String name , double value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setItemAnnotationInt32 ( PRInt64 itemId , AUTF8String name , PRInt32 value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setItemAnnotationInt64 ( PRInt64 itemId , AUTF8String name , PRInt64 value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setItemAnnotationString ( PRInt64 itemId , AUTF8String name , AString value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService void setPageAnnotation ( nsIURI URI , AUTF8String name , nsIVariant value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService void setPageAnnotationBinary ( nsIURI URI , AUTF8String name , arrayof PRUint8 data , PRUint32 dataLen , AUTF8String mimeType , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setPageAnnotationDouble ( nsIURI URI , AUTF8String name , double value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setPageAnnotationInt32 ( nsIURI URI , AUTF8String name , PRInt32 value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setPageAnnotationInt64 ( nsIURI URI , AUTF8String name , PRInt64 value , PRInt32 flags , PRUint16 expiration )
nsIAnnotationService [noscript] void setPageAnnotationString ( nsIURI URI , AUTF8String name , AString value , PRInt32 flags , PRUint16 expiration )

Reference documentation is generated from Mozilla's source.