/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Places code * * The Initial Developer of the Original Code is * Google Inc. * Portions created by the Initial Developer are Copyright (C) 2005 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Annie Sullivan * Joe Hughes * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #include "nsISupports.idl" interface nsIURI; interface nsINavBookmarksService; [scriptable, uuid(602e3a71-2d10-4d8f-80c2-6db302b5c89d)] interface nsILivemarkService : nsISupports { /** * Creates a new livemark * @param folder The id of the parent folder * @param name The name to show when displaying the livemark * @param siteURI The URI of the site the livemark was created from * @param feedURI The URI of the actual RSS feed * @param index The index to insert at, or -1 to append * @returns the ID of the folder for the livemark */ long long createLivemark(in long long folder, in AString name, in nsIURI siteURI, in nsIURI feedURI, in long index); /** * Same as above, use during startup to avoid HTTP traffic */ long long createLivemarkFolderOnly(in nsINavBookmarksService bms, in long long folder, in AString name, in nsIURI siteURI, in nsIURI feedURI, in long index); /** * Determines whether the folder with the given folder ID identifies * a livemark container. * * @param folder A folder ID * * @returns true if the given folder is a livemark folder, or * false otherwise * * @throws NS_ERROR_INVALID_ARG if the folder ID isn't known */ boolean isLivemark(in long long folder); /** * Gets the URI of the website associated with a livemark container. * * @param container The folder ID of a livemark container * * @returns nsIURI representing the URI of the website; if the livemark * container doesn't have a valid site URI, null will be returned * * @throws NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies * a folder that isn't a livemark container * @throws NS_ERROR_MALFORMED_URI if the site URI annotation has * somehow been corrupted (and can't be turned into an nsIURI) */ nsIURI getSiteURI(in long long container); /** * Sets the URI of the website associated with a livemark container. * * @param container The folder ID of a livemark container * @param siteURI nsIURI object representing the site URI, or null * to clear the site URI for this livemark container * * @throws NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies * a folder that isn't a livemark container; also if the siteURI * argument isn't a valid nsIURI object (or null) */ void setSiteURI(in long long container, in nsIURI siteURI); /** * Gets the URI of the syndication feed associated with a livemark container. * * @param container The folder ID of a livemark container * * @returns nsIURI representing the URI of the feed; if the livemark * container doesn't have a valid feed URI, null will be returned * of the nsIURI object returned will be the empty string. * * @throws NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies * a folder that isn't a livemark container * @throws NS_ERROR_MALFORMED_URI if the site URI annotation has * somehow been corrupted (and can't be turned into an nsIURI) */ nsIURI getFeedURI(in long long container); /** * Sets the URI of the feed associated with a livemark container. * * NOTE: The caller is responsible for reloading the livemark after * changing its feed URI (since the contents are likely to be different * given a different feed). * * @param container The folder ID of a livemark container * @param feedURI nsIURI object representing the syndication feed URI * * @throws NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies * a folder that isn't a livemark container; also if the feedURI * argument isn't a valid nsIURI object */ void setFeedURI(in long long container, in nsIURI feedURI); /** * Reloads all livemark subscriptions, whether or not they've expired. */ void reloadAllLivemarks(); /** * Reloads the livemark with this folder ID, whether or not it's expired. * @param folderID The ID of the folder to be reloaded */ void reloadLivemarkFolder(in long long folderID); };