diff options
Diffstat (limited to 'browser/components/sessionstore/nsISessionStore.idl')
-rw-r--r-- | browser/components/sessionstore/nsISessionStore.idl | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/browser/components/sessionstore/nsISessionStore.idl b/browser/components/sessionstore/nsISessionStore.idl new file mode 100644 index 0000000..97f9668 --- /dev/null +++ b/browser/components/sessionstore/nsISessionStore.idl @@ -0,0 +1,63 @@ +/* ***** 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 the Session Restore component. + * + * The Initial Developer of the Original Code is + * Simon Bünzli <zeniko@gmail.com> + * Portions created by the Initial Developer are Copyright (C) 2006 + * the Initial Developer. All Rights Reserved. + * + * Contributor(s): + * Dietrich Ayala <dietrich@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" + +interface nsIWebBrowser; + +/** + * nsISessionStore keeps track of the current browsing state - i.e. + * tab history, cookies, scroll state, form data, POSTDATA and window features + * - and allows to restore everything into one window. + */ + +[scriptable, uuid(11852a90-20de-11db-a98b-0800200c9a66)] +interface nsISessionStore : nsISupports +{ + /** + * @param aBrowser is the browser whose state is to be returned. + * + * @return a JSON string representing the session state. + */ + AString getBrowserState(in nsIWebBrowser aBrowser); + + /** + * @param aBrowser is the browser whose state is to be set. + * @param aState is a JSON string representing a session state. + */ + void setBrowserState(in nsIWebBrowser aBrowser, in AString aState); +}; |