Public Member Functions | Public Attributes | List of all members
fuelIAnnotations Interface Reference

import"fuelIApplication.idl";

Inheritance diagram for fuelIAnnotations:
[legend]
Collaboration diagram for fuelIAnnotations:
[legend]

Public Member Functions

boolean has (in AString aName)
 
nsIVariant get (in AString aName)
 
void set (in AString aName, in nsIVariant aValue, in PRInt32 aExpiration)
 
void remove (in AString aName)
 

Public Attributes

readonly attribute nsIVariant names
 

Detailed Description

Interface representing a collection of annotations associated with a bookmark or bookmark folder.

Definition at line 53 of file fuelIApplication.idl.

Member Function Documentation

nsIVariant fuelIAnnotations::get ( in AString  aName)

Gets the value of an annotation with the given name.

Parameters
aNameThe name of the annotation
Returns
A variant containing the value of the annotation. Supports string, boolean and number.
boolean fuelIAnnotations::has ( in AString  aName)

Determines if an annotation exists with the given name.

Parameters
aNameThe name of the annotation
Returns
true if an annotation exists with the given name, false otherwise.
void fuelIAnnotations::remove ( in AString  aName)

Removes the named annotation from the owner item.

Parameters
aNameThe name of annotation.
void fuelIAnnotations::set ( in AString  aName,
in nsIVariant  aValue,
in PRInt32  aExpiration 
)

Sets the value of an annotation with the given name.

Parameters
aNameThe name of the annotation
aValueThe new value of the annotation. Supports string, boolean and number
aExpirationThe expiration policy for the annotation. See nsIAnnotationService.

Member Data Documentation

readonly attribute nsIVariant fuelIAnnotations::names

Array of the annotation names associated with the owning item

Definition at line 58 of file fuelIApplication.idl.

The documentation for this interface was generated from the following file: