dom/power/nsIDOMWakeLockListener.idl
author Gian-Carlo Pascutto <gpascutto@mozilla.com>
Tue, 17 Apr 2012 22:01:28 +0200
changeset 91893 36c22a5ddbe5d92cc55d0fbbcbf827cc4ad02067
parent 88439 72bc6f12d1cc5237b7347f2ed737e929def0ad07
permissions -rw-r--r--
Bug 715550 - Migration of Sync settings from XUL Fennec. r=mfinkle a=blocking-fennec a=mfinkle

/* -*- Mode: C++; tab-width: 40; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

[scriptable, function, uuid(4e258af8-cffb-47bc-b16d-e8241243426e)]
interface nsIDOMMozWakeLockListener : nsISupports
{
  /**
   * The callback will be called when a lock topic changes its lock
   * state.
   *
   * Possible states are:
   *
   *  - "unlocked" - nobody holds the wake lock.
   *
   *  - "locked-foreground" - at least one window holds the wake lock,
   *    and it is visible.
   *
   *  - "locked-background" - at least one window holds the wake lock,
   *    but all of them are hidden.
   *
   * @param aTopic The resource name related to the wake lock.
   * @param aState The wake lock state
   */
  void callback(in DOMString aTopic, in DOMString aState);
};