third_party/closure_compiler/externs/passwords_private.js

   1 // Copyright 2015 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 /** @fileoverview Externs generated from namespace: passwordsPrivate */
   6
   7 /**
   8  * @const
   9  */
  10 chrome.passwordsPrivate = {};
  11
  12 /**
  13  * @typedef {{
  14  *   originUrl: string,
  15  *   username: string
  16  * }}
  17  * @see https://developer.chrome.com/extensions/passwordsPrivate#type-LoginPair
  18  */
  19 var LoginPair;
  20
  21 /**
  22  * @typedef {{
  23  *   loginPair: LoginPair,
  24  *   numCharactersInPassword: number,
  25  *   federationText: (string|undefined)
  26  * }}
  27  * @see https://developer.chrome.com/extensions/passwordsPrivate#type-PasswordUiEntry
  28  */
  29 var PasswordUiEntry;
  30
  31 /**
  32  * Determines whether account's passwords can be managed via
  33  * https://passwords.google.com/settings/passwords.
  34  * @param {function(boolean):void} callback Callback which will be passed the
  35  *     boolean of whether the     account can be managed.
  36  * @see https://developer.chrome.com/extensions/passwordsPrivate#method-canPasswordAccountBeManaged
  37  */
  38 chrome.passwordsPrivate.canPasswordAccountBeManaged = function(callback) {};
  39
  40 /**
  41  * Removes the saved password corresponding to |loginPair|. If no saved password
  42  * for this pair exists, this function is a no-op.
  43  * @param {LoginPair} loginPair The LoginPair corresponding to the entry to
  44  *     remove.
  45  * @see https://developer.chrome.com/extensions/passwordsPrivate#method-removeSavedPassword
  46  */
  47 chrome.passwordsPrivate.removeSavedPassword = function(loginPair) {};
  48
  49 /**
  50  * Removes the saved password exception corresponding to |exceptionUrl|. If no
  51  * exception with this URL exists, this function is a no-op.
  52  * @param {string} exceptionUrl The URL corresponding to the exception to
  53  *     remove.
  54  * @see https://developer.chrome.com/extensions/passwordsPrivate#method-removePasswordException
  55  */
  56 chrome.passwordsPrivate.removePasswordException = function(exceptionUrl) {};
  57
  58 /**
  59  * Returns the plaintext password corresponding to |loginPair|. Note that on
  60  * some operating systems, this call may result in an OS-level reauthentication.
  61  * @param {LoginPair} loginPair The LoginPair corresponding to the entry whose
  62  *     password     is to be returned.
  63  * @param {function(string):void} callback Callback which will be passed the
  64  *     plaintext password.
  65  * @see https://developer.chrome.com/extensions/passwordsPrivate#method-getPlaintextPassword
  66  */
  67 chrome.passwordsPrivate.getPlaintextPassword = function(loginPair, callback) {};
  68
  69 /**
  70  * Fired when the saved passwords list has changed, meaning that an entry has
  71  * been added or removed. Note that this event fires as soon as a  listener is
  72  * added.
  73  * @type {!ChromeEvent}
  74  * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onSavedPasswordsListChanged
  75  */
  76 chrome.passwordsPrivate.onSavedPasswordsListChanged;
  77
  78 /**
  79  * Fired when the password exceptions list has changed, meaning that an entry
  80  * has been added or removed. Note that this event fires as soon as a  listener
  81  * is added.
  82  * @type {!ChromeEvent}
  83  * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onPasswordExceptionsListChanged
  84  */
  85 chrome.passwordsPrivate.onPasswordExceptionsListChanged;
  86
  87