toolkit/components/feeds/nsIFeedResult.idl

Wed, 31 Dec 2014 06:09:35 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 06:09:35 +0100
changeset 0
6474c204b198
permissions
-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 /* -*- Mode: C++; tab-width: 8; 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
     4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     6 #include "nsISupports.idl"
     7 interface nsIFeedContainer;
     8 interface nsIProperties;
     9 interface nsIURI;
    11 /**
    12  * The nsIFeedResult interface provides access to HTTP and parsing
    13  * metadata for a feed or entry.
    14  */
    15 [scriptable, uuid(7a180b78-0f46-4569-8c22-f3d720ea1c57)]
    16 interface nsIFeedResult : nsISupports {
    18   /** 
    19   * The Feed parser will set the bozo bit when a feed triggers a fatal
    20   * error during XML parsing. There may be entries and feed metadata
    21   * that were parsed before the error.  Thanks to Tim Bray for
    22   * suggesting this terminology.
    23   * <http://www.tbray.org/ongoing/When/200x/2004/01/11/PostelPilgrim>
    24   */
    25   attribute boolean bozo;
    27   /**
    28   * The parsed feed or entry. 
    29   *
    30   * Will be null if a non-feed is processed.
    31   */
    32   attribute nsIFeedContainer doc;
    34   /** 
    35   * The address from which the feed was fetched. 
    36   */
    37   attribute nsIURI uri;
    39   /** 
    40   * Feed Version: 
    41   * atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03, 
    42   * atomEntry, rssItem
    43   *
    44   * Will be null if a non-feed is processed.
    45   */
    46   attribute AString version;
    48   /**
    49   * An XSLT stylesheet available to transform the source of the
    50   * feed. Some feeds include this information in a processing
    51   * instruction. It's generally intended for clients with specific
    52   * feed capabilities.
    53   */
    54   attribute nsIURI stylesheet;
    56   /**
    57   * HTTP response headers that accompanied the feed. 
    58   */
    59   attribute nsIProperties headers;
    61   /**
    62   * Registers a prefix used to access an extension in the feed/entry 
    63   */
    64   void registerExtensionPrefix(in AString aNamespace, in AString aPrefix);
    65 };

mercurial