Implementation of the DeviceInfo get API.

chrome/common/extensions/api/signedin_devices.idl

Index: chrome/common/extensions/api/signedin_devices.idl
diff --git a/chrome/common/extensions/api/signedin_devices.idl b/chrome/common/extensions/api/signedin_devices.idl
new file mode 100755
index 0000000000000000000000000000000000000000..aa4a18c794b43d0a6e8c92c06874a2c8846ed17b
--- /dev/null
+++ b/chrome/common/extensions/api/signedin_devices.idl
@@ -0,0 +1,66 @@
+// Copyright (c) 2013 The Chromium Authors. All rights reserved.

[Matt Perry, 2013/08/12 22:21:01]

Add an entry to chrome/extensions/docs/templates/public/extensions for this to
show up in the public docs.

[lipalani1, 2013/08/13 22:42:37]

Done. Not sure if I have done it right! But it follows the same pattern as
alarms. When I try to upload I get this error:
".Rendering extensions/signedin_devices.html...
<Internal>(5) : Unexpected EoF reached after
^
'canning error. Illegal character ' "
On 2013/08/12 22:21:01, Matt Perry wrote:

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// Use the <code>chrome.signedInDevices</code> to get a list of devices
+// signed into chrome with the same account as the current profile.
+[nodoc]
+namespace signedinDevices {

[Matt Perry, 2013/08/12 22:21:01]

Is "signed in" one word or two? I think two. So this should be singedInDevices
(and likewise everywhere - the permission, the namespace, the code directory).
Ditto for hacker style: signed_in_devices.

[lipalani1, 2013/08/13 22:42:37]

I decided on one word after looking at the word Signin in chromium code base
which has a wide usage. Let me know what you think.
(I have a couple of helper functions from previous check ins that used "signed
in"(2 words), but I plan to fix that in a future commit. Rest of the code is
consistently using the single word "Signedin".)
On 2013/08/12 22:21:01, Matt Perry wrote:

[dharcourt, 2013/08/15 22:12:04]

Came across this in passing: Since API callers won't be familiar with the
Chromium code base, it doesn't seem that code base usage should be a determining
factor in API choice... do we have any public APIs with "signedin" as a single
word?

If not, it seems we should follow english language conventions, and I can't find
any dictionary with "signedin" or "signin" as a single word (in fact we have it
as two word on https://accounts.google.com/Login).

Developers should be able to expect to camel case at word boundaries. If they
can't, we're making life harder for them. Internal implementation details and
code conventions don't seem like a good reason to do that.

[Matt Perry, 2013/08/15 22:25:19]

Yeah, I agree. Sorry I didn't push back more. The API really should be
signedInDevices (capital I). But that will also affect the C++ code - extension
API file, class, and directory names.

+  enum OS {
+    win,
+    mac,
+    linux,
+    chrome_os,
+    android,
+    ios,
+    unknown
+  };
+
+  enum DeviceType {
+    desktop_or_laptop,
+    phone,
+    tablet,
+    unknown
+  };
+
+  dictionary DeviceInfo {
+    // Name of the device. This name is usually set by the user
+    // when setting up a device.
+    DOMString name;
+
+    // Unique Id for this device. Note: The id is meaningul only

[Matt Perry, 2013/08/12 22:21:01]

meaningful*

[lipalani1, 2013/08/13 22:42:37]

Done.

+    // in the current device. This id cannot be used to refer to the
+    // same device from another device or extension.
+    DOMString id;
+
+    // The OS of the device.
+    OS os;
+
+    // Device Type.
+    DeviceType type;
+
+    // Version of chrome running in this device.
+    DOMString chromeVersion;
+  };
+
+  callback DeviceInfoCallback = void(DeviceInfo[] devices);
+
+  interface Functions {
+    // Gets the array of signed in devices, signed into the same account
+    // as the current profile.
+    // |isLocal|: If true only return the information for the local device. If
+    // false or omitted return the list of all devices including the local
+    // device.
+    // |callback| The callback to be invoked with the array of DeviceInfo

[Matt Perry, 2013/08/12 22:21:01]

use consistent punctuation. single : after the |variableName|

[lipalani1, 2013/08/13 22:42:37]

Done.

+    // objects.
+    static void Get(optional boolean isLocal, DeviceInfoCallback callback);
+  };
+
+  interface Events {
+    // Fired If the DeviceInfo object of any of the signed in devices

[Matt Perry, 2013/08/12 22:21:01]

lowercase if*

[lipalani1, 2013/08/13 22:42:37]

Done.

+    // change or a new device is added or a device removed.
+    // |callback|-The callback to be invoked with the array of DeviceInfo

[Matt Perry, 2013/08/12 22:21:01]

same here

[lipalani1, 2013/08/13 22:42:37]

Done.

+    // objects.
+    static void onDeviceInfoChange(DeviceInfoCallback callback);
+  };
+};