nsIPlacesTransactionsService.idl

Go to the documentation of this file.

/* -*- Mode: IDL; 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.
 *
 * The Initial Developer of the Original Code is Mozilla Corporation
 *
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Sungjoon Steve Won <stevewon@gmail.com> (Original Author)
 *   Asaf Romano <mano@mozilla.com>
 *
 * 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"
#include "nsITransactionManager.idl"

interface nsIVariant;
interface nsIURI;
interface nsIMicrosummary;
interface nsITransaction;

[scriptable, uuid(32eee5da-2bc7-4d18-8a54-a8ff0dec4d2a)]
interface nsIPlacesTransactionsService : nsITransactionManager
{
  nsITransaction aggregateTransactions(in AString aName,
                                       in nsIVariant aTransactions);

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

  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);

  nsITransaction createSeparator(in long long aContainerId,
                                 [optional] in long long aIndex);

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

  nsITransaction moveItem(in long long aItemId,
                          in long long aNewContainerId,
                          in long long aNewIndex);

  nsITransaction removeItem(in long long aItemId);

  nsITransaction editItemTitle(in long long aItemId, in AString aNewTitle);

  nsITransaction editBookmarkURI(in long long aBookmarkId, in nsIURI aNewURI);

  nsITransaction setItemAnnotation(in nsIVariant aItemId,
                                   in nsIVariant aAnnotationObject);

  nsITransaction setPageAnnotation(in nsIURI aURI,
                                   in nsIVariant aAnnotationObject);

  nsITransaction setLoadInSidebar(in long long aBookmarkId,
                                  in boolean aLoadInSidebar);

  nsITransaction editItemDescription(in long long aItemId,
                                     in AString aDescription);

  nsITransaction editBookmarkKeyword(in long long aBookmarkId,
                                     in AString aNewKeyword);

  nsITransaction editBookmarkPostData(in long long aBookmarkId,
                                      in AString aPostData);

  nsITransaction editLivemarkSiteURI(in long long aLivemarkId, in nsIURI aURI);

  nsITransaction editLivemarkFeedURI(in long long aLivemarkId, in nsIURI aURI);

  nsITransaction editBookmarkMicrosummary(in long long aBookmarkId,
                                          in nsIMicrosummary aNewMicrosummary);

  nsITransaction editItemDateAdded(in long long aItemId,
                                   in PRTime aNewDateAdded);

  nsITransaction editItemLastModified(in long long aItemId,
                                      in PRTime aNewLastModified);

  nsITransaction sortFolderByName(in long long aFolderId);

  nsITransaction tagURI(in nsIURI aURI, in nsIVariant aTags);

  nsITransaction untagURI(in nsIURI aURI, in nsIVariant aTags);
};