[Easy signin] Add method to get user info to easyUnlockPrivate

chrome/common/extensions/api/easy_unlock_private.idl

 // Copyright 2014 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.
 
 // <code>chrome.easyUnlockPrivate</code> API that provides hooks to Chrome to
 // be used by Easy Unlock component app.
 [nodoc] namespace easyUnlockPrivate {
   // Signature algorithms supported by the crypto library methods used by
   // Easy Unlock.
   enum SignatureType {
@@ skipping 111 matching lines @@
     // The name of the device.
     DOMString? name;
 
     // The permit record of the device.
     PermitRecord? permitRecord;
 
     // Websafe base64 encoded persistent symmetric key.
     DOMString? psk;
   };
 
+  // The information about a user associated with Easy unlock service.
+  dictionary UserInfo {
+    // The user id.
+    DOMString userId;
+
+    // Whether the user is logged in. If not logged in, the app is running on
+    // the signin screen.
+    boolean loggedIn;
+
+    // Whether all data needed to use Easy unlock service has been loaded for
+    // the user.
+    boolean dataReady;
+  };
+
   // Callback for crypto methods that return a single array buffer.
   callback DataCallback = void(optional ArrayBuffer data);
 
   // An empty callback used purely for signalling success vs. failure.
   callback EmptyCallback = void();
 
   // Callback for the getStrings() method.
   callback GetStringsCallback = void(object strings);
 
   // Callback for method that generates an encryption key pair.
   callback KeyPairCallback = void(optional ArrayBuffer public_key,
                                   optional ArrayBuffer private_key);
 
   // Callback for the getPermitAccess() method.
   callback GetPermitAccessCallback = void(optional PermitRecord permitAccess);
 
   // Callback for the getRemoteDevices() method.
   callback GetRemoteDevicesCallback = void(Device[] devices);
 
+  // Callback for the |getUserInfo()| method. Note that the callback argument is
+  // list for future use (on signing screen there may be more than one user

[Yoyo Zhou, 2014/09/22 23:29:06]

is a list
signin

[tbarzic, 2014/09/22 23:43:51]

Done.

+  // associated with the easy unlock service). Currently the method returns at
+  // most one user.
+  callback GetUserInfoCallback = void(UserInfo[] users);
+
   interface Functions {
     // Gets localized strings required to render the API.
     //
     // |callback| : Called with a dictionary mapping names to resource strings.
     // TODO(isherman): This is essentially copied from identity_private.idl.
     //                 Perhaps this should be extracted to a common API instead?
     static void getStrings(GetStringsCallback callback);
 
     // Generates a ECDSA key pair for P256 curve.
     // Public key will be in format recognized by secure wire transport protocol
@@ skipping 100 matching lines @@
     static void getRemoteDevices(GetRemoteDevicesCallback callback);
 
     // Gets the sign-in challenge for the current user.
     static void getSignInChallenge(DataCallback callback);
 
     // Tries to sign-in the current user with a secret obtained by decrypting
     // the sign-in challenge. Check chrome.runtime.lastError for failures. Upon
     // success, the user session will be started.
     static void trySignInSecret(ArrayBuffer signInSecret,
                                 EmptyCallback callback);
+
+    // Retrieves information about the user associated with the Easy unlock
+    // service.
+    static void getUserInfo(GetUserInfoCallback callback);
+  };
+
+  interface Events {
+    // Event dispatched when the data for the user currently associated with

[Yoyo Zhou, 2014/09/22 23:29:07]

Usually we write "Fired when"

[tbarzic, 2014/09/22 23:43:51]

Done.

+    // Easy unlock service.

[Yoyo Zhou, 2014/09/22 23:29:07]

... is updated? changes? This looks incomplete.

[tbarzic, 2014/09/22 23:43:51]

Done.

+    // |userInfo| The updated user information.
+    static void onUserInfoUpdated(UserInfo userInfo);
   };
 };