dom/power/nsIDOMWakeLockListener.idl

   1 /* -*- Mode: C++; tab-width: 40; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 [scriptable, function, uuid(4e258af8-cffb-47bc-b16d-e8241243426e)]
   9 interface nsIDOMMozWakeLockListener : nsISupports
  10 {
  11   /**
  12    * The callback will be called when a lock topic changes its lock
  13    * state.
  14    *
  15    * Possible states are:
  16    *
  17    *  - "unlocked" - nobody holds the wake lock.
  18    *
  19    *  - "locked-foreground" - at least one window holds the wake lock,
  20    *    and it is visible.
  21    *
  22    *  - "locked-background" - at least one window holds the wake lock,
  23    *    but all of them are hidden.
  24    *
  25    * @param aTopic The resource name related to the wake lock.
  26    * @param aState The wake lock state
  27    */
  28   void callback(in AString aTopic, in AString aState);
  29 };