Sessions API - previously Session Restore API. Supports restoring currently open foreign windows an…

chrome/browser/sessions/session_restore.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_SESSIONS_SESSION_RESTORE_H_
 #define CHROME_BROWSER_SESSIONS_SESSION_RESTORE_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
@@ skipping 34 matching lines @@
   // by |host_desktop_type|, if |browser| is non-null it should have the same
   // desktop type.
   //
   // If |urls_to_open| is non-empty, a tab is added for each of the URLs.
   static Browser* RestoreSession(Profile* profile,
                                  Browser* browser,
                                  chrome::HostDesktopType host_desktop_type,
                                  uint32 behavior,
                                  const std::vector<GURL>& urls_to_open);
 
-  // Specifically used in the restoration of a foreign session.  This method
+  // Specifically used in the restoration of a foreign session.  This function
   // restores the given session windows to multiple browsers all of which
-  // will be created on the desktop specified by |host_desktop_type|.
-  static void RestoreForeignSessionWindows(
+  // will be created on the desktop specified by |host_desktop_type|. The
+  // created Browsers are returned to identify the restored Windows.

[sky, 2013/08/01 00:05:43]

You don't need the last part: 'Returns the created Browsers' is fine.

[Kristen Dwan, 2013/08/02 20:54:19]

Done.

+  static std::vector<Browser*> RestoreForeignSessionWindows(
       Profile* profile,
       chrome::HostDesktopType host_desktop_type,
       std::vector<const SessionWindow*>::const_iterator begin,
       std::vector<const SessionWindow*>::const_iterator end);
 
   // Specifically used in the restoration of a foreign session.  This method
   // restores the given session tab to the browser of |source_web_contents| if
-  // the disposition is not NEW_WINDOW.
-  static void RestoreForeignSessionTab(
+  // the disposition is not NEW_WINDOW. Returns the WebContents corresponding
+  // to the restored tab.
+  static content::WebContents* RestoreForeignSessionTab(
       content::WebContents* source_web_contents,
       const SessionTab& tab,
       WindowOpenDisposition disposition);
 
   // Returns true if we're in the process of restoring |profile|.
   static bool IsRestoring(const Profile* profile);
 
   // Returns true if synchronously restoring a session.
   static bool IsRestoringSynchronously();
 
   // The max number of non-selected tabs SessionRestore loads when restoring
   // a session. A value of 0 indicates all tabs are loaded at once.
   static size_t num_tabs_to_load_;
 
  private:
   SessionRestore();
 
   DISALLOW_COPY_AND_ASSIGN(SessionRestore);
 };
 
 #endif  // CHROME_BROWSER_SESSIONS_SESSION_RESTORE_H_