toolkit/components/places/public/nsITaggingService.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Places Tagging Service code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Mozilla Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2007
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Asaf Romano <mano@mozilla.com> (Original Author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIURI;
  42 interface nsIVariant;
  43
  44 [scriptable, uuid(e39cea60-7e6d-4c8b-80a3-997af1c2cbcb)]
  45 interface nsITaggingService : nsISupports
  46 {
  47   /**
  48    * Tags a URL with the given set of tags. Current tags set for the URL
  49    * persist. Tags in aTags which are already set for the given URL are
  50    * ignored.
  51    *
  52    * @param aURI
  53    *        the URL to tag.
  54    * @param aTags
  55    *        Array of tags to set for the given URL. Each element within the
  56    *        array can be either a tag name or a concrete itemId of a tag
  57    *        container.
  58    */
  59   void tagURI(in nsIURI aURI, in nsIVariant aTags);
  60
  61   /**
  62    * Removes tags from a URL. Tags from aTags which are not set for the
  63    * given URL are ignored.
  64    *
  65    * @param aURI
  66    *        the URL to un-tag.
  67    * @param aTags
  68    *        Array of tags to unset. pass null to remove all tags from the given
  69    *        url. Each element within the array can be either a tag name or a
  70    *        concrete itemId of a tag container.
  71    */
  72   void untagURI(in nsIURI aURI, in nsIVariant aTags);
  73
  74   /**
  75    * Retrieves all URLs tagged with the given tag.
  76    *
  77    * @param aTag
  78    *        tag name
  79    * @returns Array of uris tagged with aTag.
  80    */
  81   nsIVariant getURIsForTag(in AString aTag);
  82
  83   /**
  84    * Retrieves all tags set for the given URL.
  85    *
  86    * @param aURI
  87    *        a URL.
  88    * @returns array of tags (sorted by name).
  89    */
  90   void getTagsForURI(in nsIURI aURI, out unsigned long length, [retval, array, size_is(length)] out wstring aTags);
  91
  92   /**
  93    * Retrieves all tags used to tag URIs in the data-base (sorted by name).
  94    */
  95   readonly attribute nsIVariant allTags;
  96 };
  97
  98 %{C++
  99
 100 #define TAGGING_SERVICE_CID "@mozilla.org/browser/tagging-service;1"
 101
 102 %}