Usage of nsIVariant Interface

 Can hold extra details and data associated with the event. This
 is optional and event specific. If the event does not send extra
 details, this is null.

readonly attribute nsIVariant data

 Array of extIExtension listing all extensions in the application.

readonly attribute nsIVariant all

 Get/Set the value of the preference.

attribute nsIVariant value

 Array of extIPreference listing all preferences in this branch.

readonly attribute nsIVariant all

 Array of the annotation names associated with the owning item

readonly attribute nsIVariant names

 An array of browser windows within the application.

readonly attribute nsIVariant windows

 Array of all bookmarks, separators and folders contained
 in this folder.

readonly attribute nsIVariant children

 A collection of browser tabs within the browser window.

readonly attribute nsIVariant tabs

attribute nsIVariant fillStyle

attribute nsIVariant strokeStyle

 The return value that will be returned to the function that
 opened the modal content window.

attribute nsIVariant returnValue

 Limit results to items that are tagged with all of the given tags.  This
 attribute must be set to an array of strings.  When called as a getter it
 will return an array of strings sorted ascending in lexicographical order.
 The array may be empty in either case.  Duplicate tags may be specified
 when setting the attribute, but the getter returns only unique tags.

 To search for items that are tagged with any given tags rather than all,
 multiple queries may be passed to nsINavHistoryService.executeQueries().

attribute nsIVariant tags

 Get the value of the property.

readonly attribute nsIVariant value

 Retrieves all tags used to tag URIs in the data-base (sorted by name).

readonly attribute nsIVariant allTags

 Gets the value of a preference. Returns a default value if
 the preference does not exist.
 @param   aName
          The name of preference
 @param   aDefaultValue
          The value to return if preference does not exist
 @returns value of the preference or the given default value if preference
          does not exists.

nsIVariant getValue(in AString aName, in nsIVariant aDefaultValue)

 Gets the value of a storage item with the given name. Returns a
 default value if the item does not exist.
 @param   aName
          The name of an item
 @param   aDefaultValue
          The value to return if no item exists with the given name
 @returns value of the item or the given default value if no item
          exists with the given name.

nsIVariant get(in AString aName, in nsIVariant aDefaultValue)

 Gets the value of an annotation with the given name.
 @param   aName
          The name of the annotation
 @returns A variant containing the value of the annotation. Supports
          string, boolean and number.

nsIVariant get(in AString aName)

 Called when all tuples in a group have been processed and the engine
 needs the aggregate function's value.

 @returns aggregate result as Variant.

nsIVariant onFinal()

 onFunctionCall is called when execution of a custom
 function should occur.
 
 @param aNumArguments         The number of arguments
 @param aFunctionArguments    The arguments passed in to the function

 @returns any value as Variant type.

nsIVariant onFunctionCall(in mozIStorageValueArray aFunctionArguments)

 Obtains the result of a given column specified by aIndex.

 @param aIndex
        Zero-based index of the result to get from the tuple.
 @returns the result of the specified column.

nsIVariant getResultByIndex(in unsigned long aIndex)

 Obtains the result of a given column specified by aIndex.

 @param aName
        Name of the result to get from the tuple.
 @returns the result of the specified column.

nsIVariant getResultByName(in AUTF8String aName)

nsIVariant getItemAnnotation(in long long aItemId, in AUTF8String aName)

 Retrieves the value of a given annotation. Throws an error if the
 annotation does not exist. Throws for binary annotations, for which
 getPageAnnotationBinary/getItemAnnotationBinary should be used. C++
 consumers may use the type-specific methods.

 The type-specific methods throw if the given annotation is set in
 a different type.

nsIVariant getPageAnnotation(in nsIURI aURI, in AUTF8String aName)

 Get a pref.

 Besides the regular string, integer, boolean, etc. values, this method
 may return null (nsIDataType::VTYPE_EMPTY), which means the pref is set
 to NULL in the database, as well as undefined (nsIDataType::VTYPE_VOID),
 which means there is no record for this pref in the database.

 @param    aURI        the URI for which to get the pref, or null to get
                       the global pref (applies to all URIs)
 @param    aName       the name of the pref to get

 @returns  the value of the pref

nsIVariant getPref(in nsIURI aURI, in AString aName)

nsIVariant getUserData(in DOMString key)

nsIVariant setUserData(in DOMString key, in nsIVariant data, in nsIDOMUserDataHandler handler)

nsIVariant getParameter(in DOMString name)

 Return the data associated with the given key.

 @param  key  the key
 @return      the data associated with the key

nsIVariant getData(in DOMString key)

 Retrieve the data associated with the given format for an item at the
 specified index, or null if it does not exist. The index should be in the
 range from zero to itemCount - 1.

 @param format the format of the data to look up
 @returns the data of the given format, or null if it doesn't exist.
 @throws NS_ERROR_DOM_INDEX_SIZE_ERR if index is greater or equal than itemCount

nsIVariant mozGetDataAt(in DOMString format, in unsigned long index)

nsIVariant showModalDialog(in DOMString aURI, [optional] in nsIVariant aArgs, [optional] in DOMString aOptions)

 Get a property value for the given name.
 @throws NS_ERROR_FAILURE if a property with that name doesn't
 exist.

nsIVariant getProperty(in AString name)

 This method returns null if the value does not exist,
 or exists but is null.

nsIVariant get(in AString prop)

 Retrieves all URLs tagged with the given tag.

 @param aTag
        tag name
 @returns Array of uris tagged with aTag.

nsIVariant getURIsForTag(in AString aTag)

nsIVariant JSToVariant(in JSContextPtr ctx, in JSVal value)

 Gets a parameter if previously set by setParameter. Returns null
 otherwise.

 @param namespaceURI The namespaceURI of the XSLT parameter
 @param localName    The local name of the XSLT parameter
 @return nsIVariant  The value of the XSLT parameter

nsIVariant getParameter(in DOMString namespaceURI, in DOMString localName)

 Gets the value of a preference. Returns a default value if
 the preference does not exist.
 @param   aName
          The name of preference
 @param   aDefaultValue
          The value to return if preference does not exist
 @returns value of the preference or the given default value if preference
          does not exists.

nsIVariant getValue(in AString aName, in nsIVariant aDefaultValue)

 Sets the value of a storage item with the given name.
 @param   aName
          The name of an item
 @param   aValue
          The value to assign to the item

void setValue(in AString aName, in nsIVariant aValue)

 Gets the value of a storage item with the given name. Returns a
 default value if the item does not exist.
 @param   aName
          The name of an item
 @param   aDefaultValue
          The value to return if no item exists with the given name
 @returns value of the item or the given default value if no item
          exists with the given name.

nsIVariant get(in AString aName, in nsIVariant aDefaultValue)

 Sets the value of a storage item with the given name.
 @param   aName
          The name of an item
 @param   aValue
          The value to assign to the item

void set(in AString aName, in nsIVariant aValue)

 Sets the value of an annotation with the given name.
 @param   aName
          The name of the annotation
 @param   aValue
          The new value of the annotation. Supports string, boolean
          and number
 @param   aExpiration
          The expiration policy for the annotation.
          See nsIAnnotationService.

void set(in AString aName, in nsIVariant aValue, in PRInt32 aExpiration)

 Binds aValue to the parameter with the index aIndex.

 @param aIndex
        The zero-based index of the parameter to bind aValue to.
 @param aValue
        The value to bind.

void bindByIndex(in unsigned long aIndex, in nsIVariant aValue)

 Binds aValue to the parameter with the name aName.

 @param aName
        The name of the parameter to bind aValue to.
 @param aValue
        The value to bind.

void bindByName(in AUTF8String aName, in nsIVariant aValue)

void setItemAnnotation(in long long aItemId, in AUTF8String aName, in nsIVariant aValue, in long aFlags, in unsigned short aExpiration)

 Sets an annotation, overwriting any previous annotation with the same
 URL/name. IT IS YOUR JOB TO NAMESPACE YOUR ANNOTATION NAMES.
 Use the form "namespace/value", so your name would be like
 "bills_extension/page_state" or "history/thumbnail".

 Do not use characters that are not valid in URLs such as spaces, ":",
 commas, or most other symbols. You should stick to ASCII letters and
 numbers plus "_", "-", and "/".

 aExpiration is one of EXPIRE_* above. aFlags should be 0 for now, some
 flags will be defined in the future.

 NOTE: ALL ANNOTATIONS WILL GET DELETED WHEN THE PAGE IS REMOVED FROM HISTORY,
 UNLESS YOU USE THE EXPIRE_NEVER FLAG. This means that if you create an
 annotation on a random unvisited URI, it will get deleted when the
 browser shuts down. Otherwise, things can exist in history as
 annotations but the user has no way of knowing it, potentially violating
 their privacy expectations about actions such as "Clear history." If
 there is an important annotation that the user wants to keep, you should
 make sure that you use EXPIRE_NEVER. This will ensure the item is never
 completely deleted from the Places database.

 The annotation "favicon" is special. Favicons are stored in the favicon
 service, but are special cased in the protocol handler so they look like
 annotations. Do not set favicons using this service, it will not work.

 Binary annotations should be set using
 setItemAnnotationBinary/setPageAnnotationBinary. For other types, only
 C++ consumers may use the type-specific methods.

void setPageAnnotation(in nsIURI aURI, in AUTF8String aName, in nsIVariant aValue, in long aFlags, in unsigned short aExpiration)

void getItemAnnotationNames(in long long aItemId, out unsigned long count, [array, retval, size_is(count)] out nsIVariant result)

 Get the names of all annotations for this URI.

 example JS:
   var annotations = annotator.getPageAnnotations(myURI, {});

void getPageAnnotationNames(in nsIURI aURI, out unsigned long count, [array, retval, size_is(count)] out nsIVariant result)

 Called when a content pref is set to a different value.
 
 @param    aGroup      the group to which the pref belongs, or null
                       if it's a global pref (applies to all URIs)
 @param    aName       the name of the pref that was set
 @param    aValue      the new value of the pref

void onContentPrefSet(in AString aGroup, in AString aName, in nsIVariant aValue)

 Set a pref.

 @param    aURI        the URI for which to set the pref, or null to set
                       the global pref (applies to all URIs)
 @param    aName       the name of the pref to set
 @param    aValue      the new value of the pref

void setPref(in nsIURI aURI, in AString aName, in nsIVariant aValue)

nsIVariant setUserData(in DOMString key, in nsIVariant data, in nsIDOMUserDataHandler handler)

boolean canSetParameter(in DOMString name, in nsIVariant value)

void setParameter(in DOMString name, in nsIVariant value)

 Set the data for the given key.

 @param  key   the data key
 @param  data  the data
 @throws       NS_ERROR_UNEXPECTED if the method is called during event
               dispatch

void setData(in DOMString key, in nsIVariant data)

void mozSetDataAt(in DOMString format, in nsIVariant data, in unsigned long index)

void handle(in unsigned short operation, in DOMString key, in nsIVariant data, in nsIDOMNode src, in nsIDOMNode dst)

nsIVariant showModalDialog(in DOMString aURI, [optional] in nsIVariant aArgs, [optional] in DOMString aOptions)

 Transaction for setting/unsetting an item annotation

 @param aItemId
        id of the item where to set annotation
 @param aAnnotationObject
        Object representing an annotation, containing the following
        properties: name, flags, expires, type, mimeType (only used for
        binary annotations), value.
        If value is null the annotation will be removed
 @returns nsITransaction object

nsITransaction setItemAnnotation(in nsIVariant aItemId, in nsIVariant aAnnotationObject)

 Transaction for setting/unsetting a page annotation

 @param aURI
        URI of the page where to set annotation
 @param aAnnotationObject
        Object representing an annotation, containing the following
        properties: name, flags, expires, type, mimeType (only used for
        binary annotations), value.
        If value is null the annotation will be removed
 @returns nsITransaction object

nsITransaction setPageAnnotation(in nsIURI aURI, in nsIVariant aAnnotationObject)

 Transaction for creating a new folder item.

 @param aName
        the name of the new folder
 @param aContainerId
        the identifier of the folder in which the new folder should be
        added.
 @param [optional] aIndex
        the index of the item in aContainer, pass -1 or nothing to create
        the item at the end of aContainer.
 @param [optional] aAnnotations
        the annotations to set for the new folder.
 @param [optional] aChildItemsTransactions
        array of transactions for items to be created under the new folder.
 @returns nsITransaction object

nsITransaction createFolder(in AString aName, in long long aContainerId, [optional] in long long aIndex, [optional] in nsIVariant aAnnotations, [optional] in nsIVariant aChildItemsTransactions)

 Transaction for creating a new bookmark item

 @param aURI
        the uri of the new bookmark (nsIURI)
 @param aContainerId
        the identifier of the folder in which the bookmark should be added.
 @param [optional] aIndex
        the index of the item in aContainer, pass -1 or nothing to create
        the item at the end of aContainer.
 @param [optional] aTitle
        the title of the new bookmark.
 @param [optional] aKeyword
        the keyword of the new bookmark.
 @param [optional] aAnnotations
        the annotations to set for the new bookmark.
 @param [optional] aChildTransactions
        child transactions to commit after creating the bookmark. Prefer
        using any of the arguments above if possible. In general, a child
        transations should be used only if the change it does has to be
        reverted manually when removing the bookmark item.
        a child transaction must support setting its bookmark-item
        identifier via an "id" js setter.
 @returns nsITransaction object

nsITransaction createItem(in nsIURI aURI, in long long aContainerId, [optional] in long long aIndex, [optional] in AString aTitle, [optional] in AString aKeyword, [optional] in nsIVariant aAnnotations, [optional] in nsIVariant aChildTransactions)

 Transaction for creating a new live-bookmark item.

 @see nsILivemarksService::createLivemark for documentation regarding the
 first three arguments.

 @param aContainerId
        the identifier of the folder in which the live-bookmark should be
        added.
 @param [optional]  aIndex
        the index of the item in aContainer, pass -1 or nothing to create
        the item at the end of aContainer.
 @param [optional] aAnnotations
        the annotations to set for the new live-bookmark.
 @returns nsITransaction object

nsITransaction createLivemark(in nsIURI aFeedURI, in nsIURI aSiteURI, in AString aName, in long long aContainerId, [optional] in long long aIndex, [optional] in nsIVariant aAnnotations)

 Transaction for creating a new folder item.

 @param aName
        the name of the new folder
 @param aContainerId
        the identifier of the folder in which the new folder should be
        added.
 @param [optional] aIndex
        the index of the item in aContainer, pass -1 or nothing to create
        the item at the end of aContainer.
 @param [optional] aAnnotations
        the annotations to set for the new folder.
 @param [optional] aChildItemsTransactions
        array of transactions for items to be created under the new folder.
 @returns nsITransaction object

nsITransaction createFolder(in AString aName, in long long aContainerId, [optional] in long long aIndex, [optional] in nsIVariant aAnnotations, [optional] in nsIVariant aChildItemsTransactions)

 Transaction for creating a new bookmark item

 @param aURI
        the uri of the new bookmark (nsIURI)
 @param aContainerId
        the identifier of the folder in which the bookmark should be added.
 @param [optional] aIndex
        the index of the item in aContainer, pass -1 or nothing to create
        the item at the end of aContainer.
 @param [optional] aTitle
        the title of the new bookmark.
 @param [optional] aKeyword
        the keyword of the new bookmark.
 @param [optional] aAnnotations
        the annotations to set for the new bookmark.
 @param [optional] aChildTransactions
        child transactions to commit after creating the bookmark. Prefer
        using any of the arguments above if possible. In general, a child
        transations should be used only if the change it does has to be
        reverted manually when removing the bookmark item.
        a child transaction must support setting its bookmark-item
        identifier via an "id" js setter.
 @returns nsITransaction object

nsITransaction createItem(in nsIURI aURI, in long long aContainerId, [optional] in long long aIndex, [optional] in AString aTitle, [optional] in AString aKeyword, [optional] in nsIVariant aAnnotations, [optional] in nsIVariant aChildTransactions)

 Transaction for setting/unsetting an item annotation

 @param aItemId
        id of the item where to set annotation
 @param aAnnotationObject
        Object representing an annotation, containing the following
        properties: name, flags, expires, type, mimeType (only used for
        binary annotations), value.
        If value is null the annotation will be removed
 @returns nsITransaction object

nsITransaction setItemAnnotation(in nsIVariant aItemId, in nsIVariant aAnnotationObject)

 Transaction for tagging a URL with the given set of tags. Current tags set
 for the URL persist. It's the caller's job to check whether or not aURI
 was already tagged by any of the tags in aTags, undoing this tags
 transaction removes them all from aURL!

 @param aURI
        the URL to tag.
 @param aTags
        Array of tags to set for the given URL.

nsITransaction tagURI(in nsIURI aURI, in nsIVariant aTags)

 Transaction for removing tags from a URL. It's the caller's job to check
 whether or not aURI isn't tagged by any of the tags in aTags, undoing this
 tags transaction adds them all to aURL!

 @param aURI
        the URL to un-tag.
 @param aTags
        Array of tags to unset. pass null to remove all tags from the given
        url.

nsITransaction untagURI(in nsIURI aURI, in nsIVariant aTags)

 Transaction for performing several Places Transactions in a single batch. 
 
 @param aName
        title of the aggregate transactions
 @param aTransactions
        an array of transactions to perform
 @returns nsITransaction object

nsITransaction aggregateTransactions(in AString aName, in nsIVariant aTransactions)

 Tags a URL with the given set of tags. Current tags set for the URL
 persist. Tags in aTags which are already set for the given URL are
 ignored.

 @param aURI
        the URL to tag.
 @param aTags
        Array of tags to set for the given URL. Each element within the
        array can be either a tag name or a concrete itemId of a tag
        container.

void tagURI(in nsIURI aURI, in nsIVariant aTags)

 Removes tags from a URL. Tags from aTags which are not set for the
 given URL are ignored.

 @param aURI
        the URL to un-tag.
 @param aTags
        Array of tags to unset. pass null to remove all tags from the given
        url. Each element within the array can be either a tag name or a
        concrete itemId of a tag container.

void untagURI(in nsIURI aURI, in nsIVariant aTags)

 Set a property with the given name to the given value.  If
 a property already exists with the given name, it is
 overwritten.

void setProperty(in AString name, in nsIVariant value)

void setFromVariant(in nsIVariant aValue)

 Sends the request. If the request is asynchronous, returns
 immediately after sending the request. If it is synchronous
 returns only after the response has been received.

 All event listeners must be set before calling send().

 After the initial response, all event listeners will be cleared.
 // XXXbz what does that mean, exactly?   

 @param body Either an instance of nsIDOMDocument, nsIInputStream
             or a string (nsISupportsString in the native calling
             case). This is used to populate the body of the
             HTTP request if the HTTP request method is "POST".
             If the parameter is a nsIDOMDocument, it is serialized.
             If the parameter is a nsIInputStream, then it must be
             compatible with nsIUploadChannel.setUploadStream, and a
             Content-Length header will be added to the HTTP request
             with a value given by nsIInputStream.available.  Any
             headers included at the top of the stream will be
             treated as part of the message body.  The MIME type of
             the stream should be specified by setting the Content-
             Type header via the setRequestHeader method before
             calling send.

void send([optional] in nsIVariant body)

JSVal variantToJS(in JSContextPtr ctx, in JSObjectPtr scope, in nsIVariant value)

 Sets a parameter to be used in subsequent transformations with this
 nsIXSLTProcessor. If the parameter doesn't exist in the stylesheet the
 parameter will be ignored.

 @param namespaceURI The namespaceURI of the XSLT parameter
 @param localName    The local name of the XSLT parameter
 @param value        The new value of the XSLT parameter

 @exception NS_ERROR_ILLEGAL_VALUE The datatype of value is
                                   not supported

void setParameter(in DOMString namespaceURI, in DOMString localName, in nsIVariant value)

Usage of nsIVariant Interface

Subclasses

Attributes

From extIEventItem

From extIExtensions

From extIPreference

From extIPreferenceBranch

From fuelIAnnotations

From fuelIApplication

From fuelIBookmarkFolder

From fuelIWindow

From nsIDOMCanvasRenderingContext2D

From nsIDOMModalContentWindow

From nsINavHistoryQuery

From nsIProperty

From nsITaggingService

Returns

From extIPreferenceBranch

From extISessionStorage

From fuelIAnnotations

From mozIStorageAggregateFunction

From mozIStorageFunction

From mozIStorageRow

From nsIAnnotationService

From nsIContentPrefService

From nsIDOM3Node

From nsIDOMDOMConfiguration

From nsIDOMDataContainerEvent

From nsIDOMNSDataTransfer

From nsIDOMWindowInternal

From nsIPropertyBag

From nsIPropertyBag2

From nsITaggingService

From nsIXPConnect

From nsIXSLTProcessor

Parameters

From extIPreferenceBranch

From extISessionStorage

From fuelIAnnotations

From mozIStorageBindingParams

From nsIAnnotationService

From nsIContentPrefObserver

From nsIContentPrefService

From nsIDOM3Node

From nsIDOMDOMConfiguration

From nsIDOMDataContainerEvent

From nsIDOMNSDataTransfer

From nsIDOMUserDataHandler

From nsIDOMWindowInternal

From nsIPlacesTransactionsService

From nsITaggingService

From nsIWritablePropertyBag

From nsIWritableVariant

From nsIXMLHttpRequest

From nsIXPConnect

From nsIXSLTProcessor