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

chrome/browser/extensions/api/sessions/session_id.h

 // Copyright (c) 2013 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_COMMON_EXTENSIONS_PERMISSIONS_MEDIA_GALLERIES_PERMISSION_DATA_H_
-#define CHROME_COMMON_EXTENSIONS_PERMISSIONS_MEDIA_GALLERIES_PERMISSION_DATA_H_
+#ifndef CHROME_BROWSER_EXTENSIONS_API_SESSIONS_SESSION_ID_H__
+#define CHROME_BROWSER_EXTENSIONS_API_SESSIONS_SESSION_ID_H__
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
-#include "chrome/common/extensions/permissions/api_permission.h"
-
-namespace base {
-class Value;
-}
 
 namespace extensions {
 
-// A MediaGalleriesPermissionData instance represents a single part of the
-// MediaGalleriesPermission. e.g. "read" or "allAutoDetected".
-class MediaGalleriesPermissionData {
+class SessionId {
  public:
-  MediaGalleriesPermissionData();
+  // Constructs a SessionId object for the given session information.

[not at google - send to devlin, 2013/08/15 20:16:24]

wow. git. weird. damn.

can worry about fixing this diff before submitting I suppose.

+  // |session_tag| is the string used to uniquely identify a synced foreign
+  // session from the SessionModelAssociator. In the case that SessionId
+  // represents a local session, |session_tag_| will be the empty string. |id|
+  // uniquely identifies either a window or tab object in the local or the
+  // |session_tag| session.
+  SessionId(const std::string& session_tag, int id);
 
-  // Check if |param| (which must be a MediaGalleriesPermission::CheckParam)
-  // matches the encapsulated attribute.
-  bool Check(const APIPermission::CheckParam* param) const;
+  // Returns a SessionId, representing either a local or a foreign session.
+  // In the case that the session is local, |session_tag_| will be empty string.
+  static scoped_ptr<SessionId> Parse(const std::string& session_string);

[not at google - send to devlin, 2013/08/15 20:16:24]

put static methods first. You should also mention that it accepts the format
that ToString would produce and vice versa.

[Kristen Dwan, 2013/08/16 22:03:06]

Done.

 
-  // Convert |this| into a base::Value.
-  scoped_ptr<base::Value> ToValue() const;
+  // Returns true if the SessionId represents a foreign session.
+  bool IsForeign() const;
 
-  // Populate |this| from a base::Value.
-  bool FromValue(const base::Value* value);
+  // Returns the compressed std::string representation of a SessionId.
+  std::string ToString() const;
 
-  bool operator<(const MediaGalleriesPermissionData& rhs) const;
-  bool operator==(const MediaGalleriesPermissionData& rhs) const;
-
-  std::string permission() const { return permission_; }
-
-  // This accessor is provided for IPC_STRUCT_TRAITS_MEMBER.  Please think
-  // twice before using it for anything else.
-  std::string& permission() { return permission_; }
+  const std::string& session_tag() const { return session_tag_; }
+  int id() const { return id_; }
 
  private:
-  std::string permission_;
+  // The unique identifier for a foreign session, given by the
+  // SessionModelAssociator.
+  std::string session_tag_;
+
+  // ID corresponding to a window or tab object.
+  int id_;
+
+  DISALLOW_COPY_AND_ASSIGN(SessionId);
 };
 
 }  // namespace extensions
 
-#endif  // CHROME_COMMON_EXTENSIONS_PERMISSIONS_MEDIA_GALLERIES_PERMISSION_DATA_H_
+#endif  // CHROME_BROWSER_EXTENSIONS_API_SESSIONS_SESSION_ID_H__