mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 00:25:27 +00:00
568 lines
20 KiB
Plaintext
568 lines
20 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIFile;
|
|
interface nsIURI;
|
|
interface nsITransaction;
|
|
interface nsINavHistoryBatchCallback;
|
|
|
|
/**
|
|
* Observer for bookmarks changes.
|
|
*/
|
|
[scriptable, uuid(8ab925f8-af9b-4837-afa0-ffed507212ce)]
|
|
interface nsINavBookmarkObserver : nsISupports
|
|
{
|
|
/**
|
|
* Notifies that a batch transaction has started.
|
|
* Other notifications will be sent during the batch, but the observer is
|
|
* guaranteed that onEndUpdateBatch() will be called at its completion.
|
|
* During a batch the observer should do its best to reduce the work done to
|
|
* handle notifications, since multiple changes are going to happen in a short
|
|
* timeframe.
|
|
*/
|
|
void onBeginUpdateBatch();
|
|
|
|
/**
|
|
* Notifies that a batch transaction has ended.
|
|
*/
|
|
void onEndUpdateBatch();
|
|
|
|
/**
|
|
* Notifies that an item (any type) was added. Called after the actual
|
|
* addition took place.
|
|
* When a new item is created, all the items following it in the same folder
|
|
* will have their index shifted down, but no additional notifications will
|
|
* be sent.
|
|
*
|
|
* @param aItemId
|
|
* The id of the item that was added.
|
|
* @param aParentId
|
|
* The id of the folder to which the item was added.
|
|
* @param aIndex
|
|
* The item's index in the folder.
|
|
* @param aItemType
|
|
* The type of the added item (see TYPE_* constants below).
|
|
* @param aURI
|
|
* The URI of the added item if it was TYPE_BOOKMARK, null otherwise.
|
|
* @param aTitle
|
|
* The title of the added item.
|
|
* @param aDateAdded
|
|
* The stored date added value, in microseconds from the epoch.
|
|
* @param aGUID
|
|
* The unique ID associated with the item.
|
|
* @param aParentGUID
|
|
* The unique ID associated with the item's parent.
|
|
*/
|
|
void onItemAdded(in long long aItemId,
|
|
in long long aParentId,
|
|
in long aIndex,
|
|
in unsigned short aItemType,
|
|
in nsIURI aURI,
|
|
in AUTF8String aTitle,
|
|
in PRTime aDateAdded,
|
|
in ACString aGUID,
|
|
in ACString aParentGUID);
|
|
|
|
/**
|
|
* Notifies that an item was removed. Called after the actual remove took
|
|
* place.
|
|
* When an item is removed, all the items following it in the same folder
|
|
* will have their index shifted down, but no additional notifications will
|
|
* be sent.
|
|
*
|
|
* @param aItemId
|
|
* The id of the item that was removed.
|
|
* @param aParentId
|
|
* The id of the folder from which the item was removed.
|
|
* @param aIndex
|
|
* The bookmark's index in the folder.
|
|
* @param aItemType
|
|
* The type of the item to be removed (see TYPE_* constants below).
|
|
* @param aURI
|
|
* The URI of the added item if it was TYPE_BOOKMARK, null otherwise.
|
|
* @param aGUID
|
|
* The unique ID associated with the item.
|
|
* @param aParentGUID
|
|
* The unique ID associated with the item's parent.
|
|
*/
|
|
void onItemRemoved(in long long aItemId,
|
|
in long long aParentId,
|
|
in long aIndex,
|
|
in unsigned short aItemType,
|
|
in nsIURI aURI,
|
|
in ACString aGUID,
|
|
in ACString aParentGUID);
|
|
|
|
/**
|
|
* Notifies that an item's information has changed. This will be called
|
|
* whenever any attributes like "title" are changed.
|
|
*
|
|
* @param aItemId
|
|
* The id of the item that was changed.
|
|
* @param aProperty
|
|
* The property which changed. Can be null for the removal of all of
|
|
* the annotations, in this case aIsAnnotationProperty is true.
|
|
* @param aIsAnnotationProperty
|
|
* Whether or not aProperty is the name of an annotation. If true
|
|
* aNewValue is always an empty string.
|
|
* @param aNewValue
|
|
* For certain properties, this is set to the new value of the
|
|
* property (see the list below).
|
|
* @param aLastModified
|
|
* If lastModified changed, this parameter is the new value, otherwise
|
|
* it's set to 0.
|
|
* @param aItemType
|
|
* The type of the item to be removed (see TYPE_* constants below).
|
|
* @param aParentId
|
|
* The id of the folder containing the item.
|
|
* @param aGUID
|
|
* The unique ID associated with the item.
|
|
* @param aParentGUID
|
|
* The unique ID associated with the item's parent.
|
|
*
|
|
* @note List of values that may be associated with properties:
|
|
* aProperty | aNewValue
|
|
* =====================================================================
|
|
* cleartime | Empty string (all visits to this item were removed).
|
|
* title | The new title.
|
|
* favicon | The "moz-anno" URL of the new favicon.
|
|
* uri | new URL.
|
|
* tags | Empty string (tags for this item changed)
|
|
* dateAdded | PRTime (as string) when the item was first added.
|
|
* lastModified | PRTime (as string) when the item was last modified.
|
|
*/
|
|
void onItemChanged(in long long aItemId,
|
|
in ACString aProperty,
|
|
in boolean aIsAnnotationProperty,
|
|
in AUTF8String aNewValue,
|
|
in PRTime aLastModified,
|
|
in unsigned short aItemType,
|
|
in long long aParentId,
|
|
in ACString aGUID,
|
|
in ACString aParentGUID);
|
|
|
|
/**
|
|
* Notifies that the item was visited. Can be invoked only for TYPE_BOOKMARK
|
|
* items.
|
|
*
|
|
* @param aItemId
|
|
* The id of the bookmark that was visited.
|
|
* @param aVisitId
|
|
* The id of the visit.
|
|
* @param aTime
|
|
* The time of the visit.
|
|
* @param aTransitionType
|
|
* The transition for the visit. See nsINavHistoryService::TRANSITION_*
|
|
* constants for a list of possible values.
|
|
* @param aURI
|
|
* The nsIURI for this bookmark.
|
|
* @param aParentId
|
|
* The id of the folder containing the item.
|
|
* @param aGUID
|
|
* The unique ID associated with the item.
|
|
* @param aParentGUID
|
|
* The unique ID associated with the item's parent.
|
|
*
|
|
* @see onItemChanged with property = "cleartime" for when all visits to an
|
|
* item are removed.
|
|
*
|
|
* @note The reported time is the time of the visit that was added, which may
|
|
* be well in the past since the visit time can be specified. This
|
|
* means that the visit the observer is told about may not be the most
|
|
* recent visit for that page.
|
|
*/
|
|
void onItemVisited(in long long aItemId,
|
|
in long long aVisitId,
|
|
in PRTime aTime,
|
|
in unsigned long aTransitionType,
|
|
in nsIURI aURI,
|
|
in long long aParentId,
|
|
in ACString aGUID,
|
|
in ACString aParentGUID);
|
|
|
|
/**
|
|
* Notifies that an item has been moved.
|
|
*
|
|
* @param aItemId
|
|
* The id of the item that was moved.
|
|
* @param aOldParentId
|
|
* The id of the old parent.
|
|
* @param aOldIndex
|
|
* The old index inside the old parent.
|
|
* @param aNewParentId
|
|
* The id of the new parent.
|
|
* @param aNewIndex
|
|
* The index inside the new parent.
|
|
* @param aItemType
|
|
* The type of the item to be removed (see TYPE_* constants below).
|
|
* @param aGUID
|
|
* The unique ID associated with the item.
|
|
* @param aOldParentGUID
|
|
* The unique ID associated with the old item's parent.
|
|
* @param aNewParentGUID
|
|
* The unique ID associated with the new item's parent.
|
|
*/
|
|
void onItemMoved(in long long aItemId,
|
|
in long long aOldParentId,
|
|
in long aOldIndex,
|
|
in long long aNewParentId,
|
|
in long aNewIndex,
|
|
in unsigned short aItemType,
|
|
in ACString aGUID,
|
|
in ACString aOldParentGUID,
|
|
in ACString aNewParentGUID);
|
|
};
|
|
|
|
/**
|
|
* The BookmarksService interface provides methods for managing bookmarked
|
|
* history items. Bookmarks consist of a set of user-customizable
|
|
* folders. A URI in history can be contained in one or more such folders.
|
|
*/
|
|
|
|
[scriptable, uuid(2299598b-8d83-4b67-9b13-b6d4707dcf7b)]
|
|
interface nsINavBookmarksService : nsISupports
|
|
{
|
|
/**
|
|
* The item ID of the Places root.
|
|
*/
|
|
readonly attribute long long placesRoot;
|
|
|
|
/**
|
|
* The item ID of the bookmarks menu folder.
|
|
*/
|
|
readonly attribute long long bookmarksMenuFolder;
|
|
|
|
/**
|
|
* The item ID of the top-level folder that contain the tag "folders".
|
|
*/
|
|
readonly attribute long long tagsFolder;
|
|
|
|
/**
|
|
* The item ID of the unfiled-bookmarks folder.
|
|
*/
|
|
readonly attribute long long unfiledBookmarksFolder;
|
|
|
|
/**
|
|
* The item ID of the personal toolbar folder.
|
|
*/
|
|
readonly attribute long long toolbarFolder;
|
|
|
|
/**
|
|
* This value should be used for APIs that allow passing in an index
|
|
* where an index is not known, or not required to be specified.
|
|
* e.g.: When appending an item to a folder.
|
|
*/
|
|
const short DEFAULT_INDEX = -1;
|
|
|
|
const unsigned short TYPE_BOOKMARK = 1;
|
|
const unsigned short TYPE_FOLDER = 2;
|
|
const unsigned short TYPE_SEPARATOR = 3;
|
|
// Dynamic containers are deprecated and unsupported.
|
|
// This const exists just to avoid reusing the value.
|
|
const unsigned short TYPE_DYNAMIC_CONTAINER = 4;
|
|
|
|
/**
|
|
* Inserts a child bookmark into the given folder.
|
|
*
|
|
* @param aParentId
|
|
* The id of the parent folder
|
|
* @param aURI
|
|
* The URI to insert
|
|
* @param aIndex
|
|
* The index to insert at, or DEFAULT_INDEX to append
|
|
* @param aTitle
|
|
* The title for the new bookmark
|
|
* @return The ID of the newly-created bookmark.
|
|
*
|
|
* @note aTitle will be truncated to TITLE_LENGTH_MAX and
|
|
* aURI will be truncated to URI_LENGTH_MAX.
|
|
*/
|
|
long long insertBookmark(in long long aParentId, in nsIURI aURI,
|
|
in long aIndex, in AUTF8String aTitle);
|
|
|
|
/**
|
|
* Removes a child item. Used to delete a bookmark or separator.
|
|
* @param aItemId
|
|
* The child item to remove
|
|
*/
|
|
void removeItem(in long long aItemId);
|
|
|
|
/**
|
|
* Creates a new child folder and inserts it under the given parent.
|
|
* @param aParentFolder
|
|
* The id of the parent folder
|
|
* @param aName
|
|
* The name of the new folder
|
|
* @param aIndex
|
|
* The index to insert at, or DEFAULT_INDEX to append
|
|
* @return The ID of the newly-inserted folder.
|
|
*/
|
|
long long createFolder(in long long aParentFolder, in AUTF8String name,
|
|
in long index);
|
|
|
|
/**
|
|
* Gets an undo-able transaction for removing a folder from the bookmarks
|
|
* tree.
|
|
* @param aItemId
|
|
* The id of the folder to remove.
|
|
* @return An object implementing nsITransaction that can be used to undo
|
|
* or redo the action.
|
|
*
|
|
* This method exists because complex delete->undo operations rely on
|
|
* recreated folders to have the same ID they had before they were deleted,
|
|
* so that any other items deleted in different transactions can be
|
|
* re-inserted correctly. This provides a safe encapsulation of this
|
|
* functionality without exposing the ability to recreate folders with
|
|
* specific IDs (potentially dangerous if abused by other code!) in the
|
|
* public API.
|
|
*/
|
|
nsITransaction getRemoveFolderTransaction(in long long aItemId);
|
|
|
|
/**
|
|
* Convenience function for container services. Removes
|
|
* all children of the given folder.
|
|
* @param aItemId
|
|
* The id of the folder to remove children from.
|
|
*/
|
|
void removeFolderChildren(in long long aItemId);
|
|
|
|
/**
|
|
* Moves an item to a different container, preserving its contents.
|
|
* @param aItemId
|
|
* The id of the item to move
|
|
* @param aNewParentId
|
|
* The id of the new parent
|
|
* @param aIndex
|
|
* The index under aNewParent, or DEFAULT_INDEX to append
|
|
*
|
|
* NOTE: When moving down in the same container we take into account the
|
|
* removal of the original item. If you want to move from index X to
|
|
* index Y > X you must use moveItem(id, folder, Y + 1)
|
|
*/
|
|
void moveItem(in long long aItemId, in long long aNewParentId, in long aIndex);
|
|
|
|
/**
|
|
* Inserts a bookmark separator into the given folder at the given index.
|
|
* The separator can be removed using removeChildAt().
|
|
* @param aParentId
|
|
* The id of the parent folder
|
|
* @param aIndex
|
|
* The separator's index under folder, or DEFAULT_INDEX to append
|
|
* @return The ID of the new separator.
|
|
*/
|
|
long long insertSeparator(in long long aParentId, in long aIndex);
|
|
|
|
/**
|
|
* Get the itemId given the containing folder and the index.
|
|
* @param aParentId
|
|
* The id of the diret parent folder of the item
|
|
* @param aIndex
|
|
* The index of the item within the parent folder.
|
|
* Pass DEFAULT_INDEX for the last item.
|
|
* @return The ID of the found item, -1 if the item does not exists.
|
|
*/
|
|
long long getIdForItemAt(in long long aParentId, in long aIndex);
|
|
|
|
/**
|
|
* Set the title for an item.
|
|
* @param aItemId
|
|
* The id of the item whose title should be updated.
|
|
* @param aTitle
|
|
* The new title for the bookmark.
|
|
*
|
|
* @note aTitle will be truncated to TITLE_LENGTH_MAX.
|
|
*/
|
|
void setItemTitle(in long long aItemId, in AUTF8String aTitle);
|
|
|
|
/**
|
|
* Get the title for an item.
|
|
*
|
|
* If no item title is available it will return a void string (null in JS).
|
|
*
|
|
* @param aItemId
|
|
* The id of the item whose title should be retrieved
|
|
* @return The title of the item.
|
|
*/
|
|
AUTF8String getItemTitle(in long long aItemId);
|
|
|
|
/**
|
|
* Set the date added time for an item.
|
|
*/
|
|
void setItemDateAdded(in long long aItemId, in PRTime aDateAdded);
|
|
/**
|
|
* Get the date added time for an item.
|
|
*/
|
|
PRTime getItemDateAdded(in long long aItemId);
|
|
|
|
/**
|
|
* Set the last modified time for an item.
|
|
*
|
|
* @note This is the only method that will send an itemChanged notification
|
|
* for the property. lastModified will still be updated in
|
|
* any other method that changes an item property, but we will send
|
|
* the corresponding itemChanged notification instead.
|
|
*/
|
|
void setItemLastModified(in long long aItemId, in PRTime aLastModified);
|
|
/**
|
|
* Get the last modified time for an item.
|
|
*
|
|
* @note When an item is added lastModified is set to the same value as
|
|
* dateAdded.
|
|
*/
|
|
PRTime getItemLastModified(in long long aItemId);
|
|
|
|
/**
|
|
* Get the URI for a bookmark item.
|
|
*/
|
|
nsIURI getBookmarkURI(in long long aItemId);
|
|
|
|
/**
|
|
* Get the index for an item.
|
|
*/
|
|
long getItemIndex(in long long aItemId);
|
|
|
|
/**
|
|
* Changes the index for a item. This method does not change the indices of
|
|
* any other items in the same folder, so ensure that the new index does not
|
|
* already exist, or change the index of other items accordingly, otherwise
|
|
* the indices will become corrupted.
|
|
*
|
|
* WARNING: This is API is intended for scenarios such as folder sorting,
|
|
* where the caller manages the indices of *all* items in the folder.
|
|
* You must always ensure each index is unique after a reordering.
|
|
*
|
|
* @param aItemId The id of the item to modify
|
|
* @param aNewIndex The new index
|
|
*
|
|
* @throws If aNewIndex is out of bounds.
|
|
*/
|
|
void setItemIndex(in long long aItemId, in long aNewIndex);
|
|
|
|
/**
|
|
* Get an item's type (bookmark, separator, folder).
|
|
* The type is one of the TYPE_* constants defined above.
|
|
*/
|
|
unsigned short getItemType(in long long aItemId);
|
|
|
|
/**
|
|
* Checks whether a folder is marked as read-only.
|
|
* If this is set to true, UI will not allow the user to add, remove,
|
|
* or reorder children in this folder. The default for all folders is false.
|
|
* Note: This does not restrict API calls, only UI actions.
|
|
*
|
|
* @param aItemId
|
|
* the item-id of the folder.
|
|
*/
|
|
boolean getFolderReadonly(in long long aItemId);
|
|
|
|
/**
|
|
* Sets or unsets the readonly flag from a folder.
|
|
* If this is set to true, UI will not allow the user to add, remove,
|
|
* or reorder children in this folder. The default for all folders is false.
|
|
* Note: This does not restrict API calls, only UI actions.
|
|
*
|
|
* @param aFolder
|
|
* the item-id of the folder.
|
|
* @param aReadOnly
|
|
* the read-only state (boolean).
|
|
*/
|
|
void setFolderReadonly(in long long aFolder, in boolean aReadOnly);
|
|
|
|
/**
|
|
* Returns true if the given URI is in any bookmark folder. If you want the
|
|
* results to be redirect-aware, use getBookmarkedURIFor()
|
|
*/
|
|
boolean isBookmarked(in nsIURI aURI);
|
|
|
|
/**
|
|
* Used to see if the given URI is bookmarked, or any page that redirected to
|
|
* it is bookmarked. For example, if I bookmark "mozilla.org" by manually
|
|
* typing it in, and follow the bookmark, I will get redirected to
|
|
* "www.mozilla.org". Logically, this new page is also bookmarked. This
|
|
* function, if given "www.mozilla.org", will return the URI of the bookmark,
|
|
* in this case "mozilla.org".
|
|
*
|
|
* If there is no bookmarked page found, it will return NULL.
|
|
*
|
|
* @note The function will only return bookmarks in the first 2 levels of
|
|
* redirection (1 -> 2 -> aURI).
|
|
*/
|
|
nsIURI getBookmarkedURIFor(in nsIURI aURI);
|
|
|
|
/**
|
|
* Change the bookmarked URI for a bookmark.
|
|
* This changes which "place" the bookmark points at,
|
|
* which means all annotations, etc are carried along.
|
|
*/
|
|
void changeBookmarkURI(in long long aItemId, in nsIURI aNewURI);
|
|
|
|
/**
|
|
* Get the parent folder's id for an item.
|
|
*/
|
|
long long getFolderIdForItem(in long long aItemId);
|
|
|
|
/**
|
|
* Returns the list of bookmark ids that contain the given URI.
|
|
*/
|
|
void getBookmarkIdsForURI(in nsIURI aURI, [optional] out unsigned long count,
|
|
[array, retval, size_is(count)] out long long bookmarks);
|
|
|
|
/**
|
|
* Associates the given keyword with the given bookmark.
|
|
*
|
|
* Use an empty keyword to clear the keyword associated with the URI.
|
|
* In both of these cases, succeeds but does nothing if the URL/keyword is not found.
|
|
*/
|
|
void setKeywordForBookmark(in long long aItemId, in AString aKeyword);
|
|
|
|
/**
|
|
* Retrieves the keyword for the given URI. Will be void string
|
|
* (null in JS) if no such keyword is found.
|
|
*/
|
|
AString getKeywordForURI(in nsIURI aURI);
|
|
|
|
/**
|
|
* Retrieves the keyword for the given bookmark. Will be void string
|
|
* (null in JS) if no such keyword is found.
|
|
*/
|
|
AString getKeywordForBookmark(in long long aItemId);
|
|
|
|
/**
|
|
* Returns the URI associated with the given keyword. Empty if no such
|
|
* keyword is found.
|
|
*/
|
|
nsIURI getURIForKeyword(in AString keyword);
|
|
|
|
/**
|
|
* Adds a bookmark observer. If ownsWeak is false, the bookmark service will
|
|
* keep an owning reference to the observer. If ownsWeak is true, then
|
|
* aObserver must implement nsISupportsWeakReference, and the bookmark
|
|
* service will keep a weak reference to the observer.
|
|
*/
|
|
void addObserver(in nsINavBookmarkObserver observer, in boolean ownsWeak);
|
|
|
|
/**
|
|
* Removes a bookmark observer.
|
|
*/
|
|
void removeObserver(in nsINavBookmarkObserver observer);
|
|
|
|
/**
|
|
* Runs the passed callback inside of a database transaction.
|
|
* Use this when a lot of things are about to change, for example
|
|
* adding or deleting a large number of bookmark items. Calls can
|
|
* be nested. Observers are notified when batches begin and end, via
|
|
* nsINavBookmarkObserver.onBeginUpdateBatch/onEndUpdateBatch.
|
|
*
|
|
* @param aCallback
|
|
* nsINavHistoryBatchCallback interface to call.
|
|
* @param aUserData
|
|
* Opaque parameter passed to nsINavBookmarksBatchCallback
|
|
*/
|
|
void runInBatchMode(in nsINavHistoryBatchCallback aCallback,
|
|
in nsISupports aUserData);
|
|
};
|