toolkit/components/feeds/nsIFeedResult.idl@925c144e1f1f (annotated)
toolkit/components/feeds/nsIFeedResult.idl
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | interface nsIFeedContainer; |
| michael@0 | 8 | interface nsIProperties; |
| michael@0 | 9 | interface nsIURI; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * The nsIFeedResult interface provides access to HTTP and parsing |
| michael@0 | 13 | * metadata for a feed or entry. |
| michael@0 | 14 | */ |
| michael@0 | 15 | [scriptable, uuid(7a180b78-0f46-4569-8c22-f3d720ea1c57)] |
| michael@0 | 16 | interface nsIFeedResult : nsISupports { |
| michael@0 | 17 | |
| michael@0 | 18 | /** |
| michael@0 | 19 | * The Feed parser will set the bozo bit when a feed triggers a fatal |
| michael@0 | 20 | * error during XML parsing. There may be entries and feed metadata |
| michael@0 | 21 | * that were parsed before the error. Thanks to Tim Bray for |
| michael@0 | 22 | * suggesting this terminology. |
| michael@0 | 23 | * <http://www.tbray.org/ongoing/When/200x/2004/01/11/PostelPilgrim> |
| michael@0 | 24 | */ |
| michael@0 | 25 | attribute boolean bozo; |
| michael@0 | 26 | |
| michael@0 | 27 | /** |
| michael@0 | 28 | * The parsed feed or entry. |
| michael@0 | 29 | * |
| michael@0 | 30 | * Will be null if a non-feed is processed. |
| michael@0 | 31 | */ |
| michael@0 | 32 | attribute nsIFeedContainer doc; |
| michael@0 | 33 | |
| michael@0 | 34 | /** |
| michael@0 | 35 | * The address from which the feed was fetched. |
| michael@0 | 36 | */ |
| michael@0 | 37 | attribute nsIURI uri; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * Feed Version: |
| michael@0 | 41 | * atom, rss2, rss09, rss091, rss091userland, rss092, rss1, atom03, |
| michael@0 | 42 | * atomEntry, rssItem |
| michael@0 | 43 | * |
| michael@0 | 44 | * Will be null if a non-feed is processed. |
| michael@0 | 45 | */ |
| michael@0 | 46 | attribute AString version; |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * An XSLT stylesheet available to transform the source of the |
| michael@0 | 50 | * feed. Some feeds include this information in a processing |
| michael@0 | 51 | * instruction. It's generally intended for clients with specific |
| michael@0 | 52 | * feed capabilities. |
| michael@0 | 53 | */ |
| michael@0 | 54 | attribute nsIURI stylesheet; |
| michael@0 | 55 | |
| michael@0 | 56 | /** |
| michael@0 | 57 | * HTTP response headers that accompanied the feed. |
| michael@0 | 58 | */ |
| michael@0 | 59 | attribute nsIProperties headers; |
| michael@0 | 60 | |
| michael@0 | 61 | /** |
| michael@0 | 62 | * Registers a prefix used to access an extension in the feed/entry |
| michael@0 | 63 | */ |
| michael@0 | 64 | void registerExtensionPrefix(in AString aNamespace, in AString aPrefix); |
| michael@0 | 65 | }; |
