Webapp changes to support asking for a PIN

remoting/webapp/client_plugin.js

 // 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.
 
 /** @suppress {duplicate} */
 var remoting = remoting || {};
 
 /**
  * Interface used for ClientPlugin objects.
  * @interface
@@ skipping 13 matching lines @@
 /** @type {function(string): void} Outgoing signaling message callback. */
 remoting.ClientPlugin.prototype.onOutgoingIqHandler;
 /** @type {function(string): void} Debug messages callback. */
 remoting.ClientPlugin.prototype.onDebugMessageHandler;
 /** @type {function(number, number): void} State change callback. */
 remoting.ClientPlugin.prototype.onConnectionStatusUpdateHandler;
 /** @type {function(boolean): void} Connection ready state callback. */
 remoting.ClientPlugin.prototype.onConnectionReadyHandler;
 /** @type {function(): void} Desktop size change callback. */
 remoting.ClientPlugin.prototype.onDesktopSizeUpdateHandler;
+/** @type {function(): void} Request a PIN from the user. */
+remoting.ClientPlugin.prototype.fetchPinHandler;
 
 /**
  * Initializes the plugin asynchronously and calls specified function
  * when done.
  *
  * @param {function(boolean): void} onDone Function to be called when
  * the plugin is initialized. Parameter is set to true when the plugin
  * is loaded successfully.
  */
 remoting.ClientPlugin.prototype.initialize = function(onDone) {};
 
 /**
  * @return {boolean} True if the plugin and web-app versions are compatible.
  */
 remoting.ClientPlugin.prototype.isSupportedVersion = function() {};
 
 /**
  * Set of features for which hasFeature() can be used to test.
  *
  * @enum {string}
  */
 remoting.ClientPlugin.Feature = {
   INJECT_KEY_EVENT: 'injectKeyEvent',
   NOTIFY_CLIENT_DIMENSIONS: 'notifyClientDimensions',
   NOTIFY_CLIENT_RESOLUTION: 'notifyClientResolution',
+  ON_PIN_FETCHED: 'onPinFetched',
+  USE_ASYNC_PIN_DIALOG: 'useAsyncPinDialog',

[Sergey Ulanov, 2013/03/17 20:45:50]

Why do these need to be two separate features? Would we ever need one without
the other? Feature names do not need to match method names. I think you could
have just one feature (e.g. called asyncPin) 

[Jamie, 2013/03/18 20:28:23]

+1

[rmsousa, 2013/03/18 21:58:01]

Done.

   PAUSE_VIDEO: 'pauseVideo',
   PAUSE_AUDIO: 'pauseAudio',
   REMAP_KEY: 'remapKey',
   SEND_CLIPBOARD_ITEM: 'sendClipboardItem',
   TRAP_KEY: 'trapKey'
 };
 
 /**
  * @param {remoting.ClientPlugin.Feature} feature The feature to test for.
  * @return {boolean} True if the plugin supports the named feature.
@@ skipping 54 matching lines @@
  */
 remoting.ClientPlugin.prototype.remapKey =
     function(fromKeycode, toKeycode) {};
 
 /**
  * Enable/disable redirection of the specified key to the web-app.
  *
  * @param {number} keycode The USB-style code of the key.
  * @param {Boolean} trap True to enable trapping, False to disable.
  */
-remoting.ClientPlugin.prototype.trapKey = function(keycode, trap) {}
+remoting.ClientPlugin.prototype.trapKey = function(keycode, trap) {};
 
 /**
  * Returns an associative array with a set of stats for this connection.
  *
  * @return {remoting.ClientSession.PerfStats} The connection statistics.
  */
 remoting.ClientPlugin.prototype.getPerfStats = function() {};
 
 /**
  * Sends a clipboard item to the host.
@@ skipping 21 matching lines @@
 remoting.ClientPlugin.prototype.pauseVideo =
     function(pause) {};
 
 /**
  * Requests that the host pause or resume sending audio updates.
  *
  * @param {boolean} pause True to suspend audio updates, false otherwise.
  */
 remoting.ClientPlugin.prototype.pauseAudio =
     function(pause) {};
+
+/**
+ * Gives the client authenticator the PIN.
+ *
+ * @param {string} pin The PIN.
+ */
+remoting.ClientPlugin.prototype.onPinFetched =
+    function(pin) {};

[Jamie, 2013/03/18 20:28:23]

Nit: No need to wrap this line.

[rmsousa, 2013/03/18 21:58:01]

Done.

+
+/**
+ * Tells the plugin to ask for the PIN asynchronously.
+ */
+remoting.ClientPlugin.prototype.useAsyncPinDialog = function() {};