File: nsIAboutNewTabService.idl

package info (click to toggle)
firefox-esr 52.8.1esr-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 1,983,244 kB
  • sloc: cpp: 4,810,275; ansic: 2,004,548; python: 451,282; java: 241,615; asm: 178,649; xml: 136,302; sh: 82,207; makefile: 22,575; perl: 15,783; objc: 4,389; yacc: 1,816; ada: 1,697; pascal: 1,519; lex: 1,257; cs: 879; exp: 499; php: 436; lisp: 258; awk: 152; sed: 51; ruby: 47; csh: 27
file content (63 lines) | stat: -rw-r--r-- 1,627 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/* 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 (remote or local depending on pref)
   */
  attribute ACString defaultURL;

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

  /**
   * Returns true if the default resource is remotely hosted and isn't
   * overridden
   */
  readonly attribute bool remoteEnabled;


  /**
  * Returns the version of the remote newtab page expected
  */
  readonly attribute ACString remoteVersion;

  /**
   * Returns the expected channel for the remote the newtab page
   */
  readonly attribute ACString remoteReleaseName;

  /**
   * Generates and returns the remote newtab page url
   */
  ACString generateRemoteURL();

  /**
   * Returns a remote new tab release name given an update channel name
   */
  ACString releaseFromUpdateChannel(in ACString channelName);

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