remoting/webapp/crd/js/host_list_api.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * API for host-list management.
   8  */
   9
  10 /** @suppress {duplicate} */
  11 var remoting = remoting || {};
  12
  13 (function() {
  14
  15 'use strict';
  16
  17 /** @interface */
  18 remoting.HostListApi = function() {
  19 };
  20
  21 /**
  22  * Registers a new host with the host registry service (either the
  23  * Chromoting registry or GCD).
  24  *
  25  * @param {string} hostName The user-visible name of the new host.
  26  * @param {string} publicKey The public half of the host's key pair.
  27  * @param {string} hostClientId The OAuth2 client ID of the host.
  28  * @return {!Promise<remoting.HostListApi.RegisterResult>}
  29  */
  30 remoting.HostListApi.prototype.register = function(
  31     hostName, publicKey, hostClientId) {
  32 };
  33
  34 /**
  35  * Fetch the list of hosts for a user.
  36  *
  37  * @return {!Promise<!Array<!remoting.Host>>}
  38  */
  39 remoting.HostListApi.prototype.get = function() {
  40 };
  41
  42 /**
  43  * Update the information for a host.
  44  *
  45  * @param {string} hostId
  46  * @param {string} hostName
  47  * @param {string} hostPublicKey
  48  * @return {!Promise<void>}
  49  */
  50 remoting.HostListApi.prototype.put =
  51     function(hostId, hostName, hostPublicKey) {
  52 };
  53
  54 /**
  55  * Delete a host.
  56  *
  57  * @param {string} hostId
  58  * @return {!Promise<void>}
  59  */
  60 remoting.HostListApi.prototype.remove = function(hostId) {
  61 };
  62
  63 /**
  64  * Attempts to look up a host using an ID derived from its publicly
  65  * visible access code.
  66  *
  67  * @param {string} supportId The support ID of the host to connect to.
  68  * @return {!Promise<!remoting.Host>}
  69  */
  70 remoting.HostListApi.prototype.getSupportHost = function(supportId) {
  71 };
  72
  73 /**
  74  * @private {remoting.HostListApi}
  75  */
  76 var instance = null;
  77
  78 /**
  79  * @return {!remoting.HostListApi}
  80  */
  81 remoting.HostListApi.getInstance = function() {
  82   if (instance == null) {
  83     if (remoting.settings.USE_GCD) {
  84       var gcdInstance = new remoting.GcdHostListApi();
  85       var legacyInstance = new remoting.LegacyHostListApi();
  86       instance = new remoting.CombinedHostListApi(legacyInstance, gcdInstance);
  87     } else {
  88       instance = new remoting.LegacyHostListApi();
  89     }
  90   }
  91   return instance;
  92 };
  93
  94 /**
  95  * For testing.
  96  * @param {remoting.HostListApi} newInstance
  97  */
  98 remoting.HostListApi.setInstance = function(newInstance) {
  99   instance = newInstance;
 100 };
 101
 102 })();
 103
 104 /**
 105  * Information returned from the registry/GCD server when registering
 106  * a device.
 107  *
 108  * The fields are:
 109  *
 110  * authCode: An OAuth2 authorization code that can be exchanged for a
 111  *     refresh token.
 112  *
 113  * email: The email/XMPP address of the robot account associated with
 114  *     this device.  The Chromoting directory sets this field to the
 115  *     empty string; GCD returns a real email address.
 116  *
 117  * hostId: The ID of the newly registered host.
 118  *
 119  * @typedef {{
 120  *   authCode: string,
 121  *   email: string,
 122  *   hostId: string
 123  * }}
 124  */
 125 remoting.HostListApi.RegisterResult;