activity-stream/nsIAboutNewTabService.idl

/* 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"

/**
 * Allows to override about:newtab to point to a different location
 * than the one specified within AboutRedirector.cpp
 */

[scriptable, uuid(dfcd2adc-7867-4d3a-ba70-17501f208142)]
interface nsIAboutNewTabService : nsISupports
{
  /**
   * Returns the url of the resource for the newtab page if not overridden,
   * otherwise a string represenation of the new URL.
   */
  attribute ACString newTabURL;

  /**
   * Returns the default URL (local or activity stream depending on pref)
   */
  attribute ACString defaultURL;

  /**
   * Returns the about:welcome URL.
   */
  attribute ACString welcomeURL;

  /**
   * Returns true if opening the New Tab page will notify the user of a change.
   */
  attribute bool willNotifyUser;

  /**
   * Returns true if the default resource got overridden.
   */
  readonly attribute bool overridden;

  /**
   * Returns true if the default resource is activity stream and isn't
   * overridden
   */
  readonly attribute bool activityStreamEnabled;

  /**
   * Returns true if the the debug pref for activity stream is true
   */
  readonly attribute bool activityStreamDebug;

  /**
   * Resets to the default resource and also resets the
   * overridden attribute to false.
   */
  void resetNewTabURL();

  /**
  * Records a scalar metric for how long it takes to pain Top Sites, this will
  * only record the first timestamp, all the subsequent calls will be ignored.
  */
  void maybeRecordTopsitesPainted(in unsigned long long timestamp);
};