Separate host desktop related functionality into remoting.HostDesktop

remoting/webapp/crd/js/client_plugin.js

 // 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.
 
 /**
  * @fileoverview
  * Interface abstracting the ClientPlugin functionality.
  */
 
 'use strict';
 
 /** @suppress {duplicate} */
 var remoting = remoting || {};
 
 /**
  * @interface
  * @extends {base.Disposable}
  */
 remoting.ClientPlugin = function() {};
 
 /**
- * @return {number} The width of the remote desktop, in pixels.
+ * @return {remoting.HostDesktop}
  */
-remoting.ClientPlugin.prototype.getDesktopWidth = function() {};
-
-/**
- * @return {number} The height of the remote desktop, in pixels.
- */
-remoting.ClientPlugin.prototype.getDesktopHeight = function() {};
-
-/**
- * @return {number} The x-DPI of the remote desktop.
- */
-remoting.ClientPlugin.prototype.getDesktopXDpi = function() {};
-
-/**
- * @return {number} The y-DPI of the remote desktop.
- */
-remoting.ClientPlugin.prototype.getDesktopYDpi = function() {};
+remoting.ClientPlugin.prototype.hostDesktop = function() {};
 
 /**
  * @return {HTMLElement} The DOM element representing the remote session.
  */
 remoting.ClientPlugin.prototype.element = function() {};
 
 /**
  * @param {function(boolean):void} onDone Completion callback.
  */
 remoting.ClientPlugin.prototype.initialize = function(onDone) {};
@@ skipping 31 matching lines @@
  * @param {number} to
  */
 remoting.ClientPlugin.prototype.remapKey = function(from, to) {};
 
 /**
  * Release all keys currently being pressed.
  */
 remoting.ClientPlugin.prototype.releaseAllKeys = function() {};
 
 /**
- * @param {number} width
- * @param {number} height
- * @param {number} dpi
- */
-remoting.ClientPlugin.prototype.notifyClientResolution =
-    function(width, height, dpi) {};
-
-/**
  * @param {string} iq
  */
 remoting.ClientPlugin.prototype.onIncomingIq = function(iq) {};
 
 /**
  * @return {boolean} True if the web-app and plugin are compatible.
  */
 remoting.ClientPlugin.prototype.isSupportedVersion = function() {};
 
 /**
  * @param {remoting.ClientPlugin.Feature} feature
  * @return {boolean} True if the plugin support the specified feature.

[Jamie, 2015/02/18 23:06:19]

We need to be very careful about the definitions of Feature vs. Capability. I
think this interface is probably the right place to make the distinction,
probably in the comments for this method and the next one.

[kelvinp, 2015/02/19 20:58:15]

Acknowledged.

[Jamie, 2015/02/19 22:44:04]

Actually, I was suggesting that you document it in this CL :) I'm not sure it's
still necessary if you get rid of hasCapability from this interface, but if you
keep both, then I think you need to make it clear what the difference is.

  */
 remoting.ClientPlugin.prototype.hasFeature = function(feature) {};
 
 /**
+ * @param {string} capability
+ * @return {boolean} True if the host support the specified capability.
+ */
+remoting.ClientPlugin.prototype.hasCapability = function(capability) {};
+
+/**
  * Sends a clipboard item to the host.
  *
  * @param {string} mimeType The MIME type of the clipboard item.
  * @param {string} item The clipboard item.
  */
 remoting.ClientPlugin.prototype.sendClipboardItem =
     function(mimeType, item) {};
 
 /**
  * Tell the plugin to request a PIN asynchronously.
@@ skipping 84 matching lines @@
 remoting.ClientPlugin.prototype.setRouteChangedHandler = function(handler) {};
 
 /**
  * @param {function(boolean):void} handler Callback for connection readiness
  *     notifications.
  */
 remoting.ClientPlugin.prototype.setConnectionReadyHandler =
     function(handler) {};
 
 /**
- * @param {function():void} handler Callback for desktop size change
- *     notifications.
- */
-remoting.ClientPlugin.prototype.setDesktopSizeUpdateHandler =
-    function(handler) {};
-
-/**
- * @param {function(Array<Array<number>>):void} handler Callback for desktop
- *     shape change notifications.
- */
-remoting.ClientPlugin.prototype.setDesktopShapeUpdateHandler =
-    function(handler) {};
-
-/**
  * @param {function(!Array<string>):void} handler Callback to inform of
  *     capabilities negotiated between host and client.
  */
 remoting.ClientPlugin.prototype.setCapabilitiesHandler =
     function(handler) {};
 
 /**
  * @param {function(string):void} handler Callback for processing security key
  *     (Gnubby) protocol messages.
  */
@@ skipping 75 matching lines @@
 /**
  * Preload the plugin to make instantiation faster when the user tries
  * to connect.
  */
 remoting.ClientPluginFactory.prototype.preloadPlugin = function() {};
 
 /**
  * @type {remoting.ClientPluginFactory}
  */
 remoting.ClientPlugin.factory = null;