Identity API: add chrome.identity.getProfileUserInfo

chrome/common/extensions/api/identity.idl

 // 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.
 
 // Use the <code>chrome.identity</code> API to get OAuth2 access tokens.
 namespace identity {
 
   dictionary AccountInfo {
     // A unique identifier for the account. This ID will not change
     // for the lifetime of the account.
     DOMString id;
   };
 
+  dictionary ProfileUserInfo {
+    // An email address for the user account signed into the current
+    // profile. Empty if the user is not signed in.
+    DOMString email;
+
+    // A unique identifier for the account. This ID will not change
+    // for the lifetime of the account. Empty if the user is not
+    // signed in.
+    DOMString id;
+  };
+
   dictionary TokenDetails {
     // Fetching a token may require the user to sign-in to Chrome, or
     // approve the application's requested scopes. If the interactive
     // flag is <code>true</code>, <code>getAuthToken</code> will
     // prompt the user as necessary. When the flag is
     // <code>false</code> or omitted, <code>getAuthToken</code> will
     // return failure any time a prompt would be required.
     boolean? interactive;
 
     // The account ID whose token should be returned. If not
@@ skipping 23 matching lines @@
     // If the interactive flag is <code>true</code>, the window will
     // be displayed when a page load completes. If the flag is
     // <code>false</code> or omitted, <code>launchWebAuthFlow</code>
     // will return with an error if the initial navigation does not
     // complete the flow.
     boolean? interactive;
   };
 
   callback GetAuthTokenCallback = void (optional DOMString token);
   callback GetAccountsCallback = void (AccountInfo[] accounts);
+  callback GetProfileUserInfoCallback = void (ProfileUserInfo userInfo);
   callback InvalidateAuthTokenCallback = void ();
   callback LaunchWebAuthFlowCallback = void (optional DOMString responseUrl);
 
   interface Functions {
     // Retrieves a list of AccountInfo objects describing the accounts
     // present on the profile.<br>
     // <code>getAccounts</code> is only supported on dev channel.
     static void getAccounts(GetAccountsCallback callback);
 
     // Gets an OAuth2 access token using the client ID and scopes
@@ skipping 11 matching lines @@
     // or Chrome sign in screens if they are not signed in, with with no
     // context. In particular, do not use <code>getAuthToken</code>
     // interactively when your app is first launched.
     //
     // |details| : Token options.
     // |callback| : Called with an OAuth2 access token as specified by the
     // manifest, or undefined if there was an error.
     static void getAuthToken(optional TokenDetails details,
                              GetAuthTokenCallback callback);
 
+    // Retrieves email address and obfuscated gaia id of the user
+    // signed into a profile.
+    //
+    // This API is different from identity.getAccounts in two
+    // ways. The information returned is available offline, and it
+    // only applies to the primary account for the profile.
+    static void getProfileUserInfo(GetProfileUserInfoCallback callback);
+
     // Removes an OAuth2 access token from the Identity API's token cache.
     //
     // If an access token is discovered to be invalid, it should be
     // passed to removeCachedAuthToken to remove it from the
     // cache. The app may then retrieve a fresh token with
     // <code>getAuthToken</code>.
     //
     // |details| : Token information.
     // |callback| : Called when the token has been removed from the cache.
     static void removeCachedAuthToken(
@@ skipping 27 matching lines @@
     //
     // |path| : The path appended to the end of the generated URL.
     [nocompile] static DOMString getRedirectURL(optional DOMString path);
   };
 
   interface Events {
     // Fired when signin state changes for an account on the user's profile.
     static void onSignInChanged(AccountInfo account, boolean signedIn);
   };
 };