author Olli Pettay <>
Tue, 24 Mar 2009 17:43:15 +0200
changeset 26507 6955c8360d08c4e1a819e6322d694002f33c9ba1
parent 26323 0c0517267c4a29be2465f44b0c4acb1427ff54ea
permissions -rw-r--r--
Bug 484320, r=dveditz, sr=mrbkap, a=blocking1.9.1

/* -*- 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
 * 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 code.
 * The Initial Developer of the Original Code is
 * Mozilla Corporation
 * Portions created by the Initial Developer are Copyright (C) 2008
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *    Jan Bambas <>
 * Alternatively, the contents of this file may be used under the terms of
 * either of 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 "domstubs.idl"

 * Interface for client side storage. See
 * for more information.
 * A storage object stores an arbitrary set of key-value pairs, which
 * may be retrieved, modified and removed as needed. A key may only
 * exist once within a storage object, and only one value may be
 * associated with a particular key. Keys are stored in a particular
 * order with the condition that this order not change by merely changing
 * the value associated with a key, but the order may change when a
 * key is added or removed.

[scriptable, uuid(A67BA00F-CCB8-4ffe-BADA-F8913CAAFB20)]
interface nsIDOMStorage2 : nsISupports
   * The number of keys stored.
  readonly attribute unsigned long length;

   * Retrieve the name of the key at a particular index.
   * @param index index of the item to retrieve
   * @returns the key at index
   * @throws INDEX_SIZE_ERR if there is no key at that index
  DOMString key(in unsigned long index);

   * Retrieve an item with a given key
   * @param key key to retrieve
   * @returns found data or empty string if the key was not found
  DOMString getItem(in DOMString key);

   * Assign a value with a key. If the key does not exist already, a new
   * key is added associated with that value. If the key already exists,
   * then the existing value is replaced with a new value.
   * @param key key to set
   * @param data data to associate with the key
  void setItem(in DOMString key, in DOMString data);

   * Remove a key and its corresponding value.
   * @param key key to remove
  void removeItem(in DOMString key);

   * Clear the content of this storage bound to a domain
   * or an origin.
  void clear();