toolkit/components/feeds/nsIFeed.idl@925c144e1f1f (annotated)
toolkit/components/feeds/nsIFeed.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 "nsIFeedContainer.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIArray; |
| michael@0 | 9 | interface nsIFeedGenerator; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * An nsIFeed represents a single Atom or RSS feed. |
| michael@0 | 13 | */ |
| michael@0 | 14 | [scriptable, uuid(3b8aae33-80e2-4efa-99c8-a6c5b99f76ea)] |
| michael@0 | 15 | interface nsIFeed : nsIFeedContainer |
| michael@0 | 16 | { |
| michael@0 | 17 | /** |
| michael@0 | 18 | * Uses description, subtitle, and extensions |
| michael@0 | 19 | * to generate a summary. |
| michael@0 | 20 | */ |
| michael@0 | 21 | attribute nsIFeedTextConstruct subtitle; |
| michael@0 | 22 | |
| michael@0 | 23 | // All content classifies as a "feed" - it is the transport. |
| michael@0 | 24 | const unsigned long TYPE_FEED = 0; |
| michael@0 | 25 | const unsigned long TYPE_AUDIO = 1; |
| michael@0 | 26 | const unsigned long TYPE_IMAGE = 2; |
| michael@0 | 27 | const unsigned long TYPE_VIDEO = 4; |
| michael@0 | 28 | |
| michael@0 | 29 | /** |
| michael@0 | 30 | * The type of feed. For example, a podcast would be TYPE_AUDIO. |
| michael@0 | 31 | */ |
| michael@0 | 32 | readonly attribute unsigned long type; |
| michael@0 | 33 | |
| michael@0 | 34 | /** |
| michael@0 | 35 | * The total number of enclosures found in the feed. |
| michael@0 | 36 | */ |
| michael@0 | 37 | attribute long enclosureCount; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * The items or entries in feed. |
| michael@0 | 41 | */ |
| michael@0 | 42 | attribute nsIArray items; |
| michael@0 | 43 | |
| michael@0 | 44 | /** |
| michael@0 | 45 | * No one really knows what cloud is for. |
| michael@0 | 46 | * |
| michael@0 | 47 | * It supposedly enables some sort of interaction with an XML-RPC or |
| michael@0 | 48 | * SOAP service. |
| michael@0 | 49 | */ |
| michael@0 | 50 | attribute nsIWritablePropertyBag2 cloud; |
| michael@0 | 51 | |
| michael@0 | 52 | /** |
| michael@0 | 53 | * Information about the software that produced the feed. |
| michael@0 | 54 | */ |
| michael@0 | 55 | attribute nsIFeedGenerator generator; |
| michael@0 | 56 | |
| michael@0 | 57 | /** |
| michael@0 | 58 | * An image url and some metadata (as defined by RSS2). |
| michael@0 | 59 | * |
| michael@0 | 60 | */ |
| michael@0 | 61 | attribute nsIWritablePropertyBag2 image; |
| michael@0 | 62 | |
| michael@0 | 63 | /** |
| michael@0 | 64 | * No one really knows what textInput is for. |
| michael@0 | 65 | * |
| michael@0 | 66 | * See |
| michael@0 | 67 | * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput> |
| michael@0 | 68 | * for more details. |
| michael@0 | 69 | */ |
| michael@0 | 70 | attribute nsIWritablePropertyBag2 textInput; |
| michael@0 | 71 | |
| michael@0 | 72 | /** |
| michael@0 | 73 | * Days to skip fetching. This field was supposed to designate |
| michael@0 | 74 | * intervals for feed fetching. It's not generally implemented. For |
| michael@0 | 75 | * example, if this array contained "Monday", aggregators should not |
| michael@0 | 76 | * fetch the feed on Mondays. |
| michael@0 | 77 | */ |
| michael@0 | 78 | attribute nsIArray skipDays; |
| michael@0 | 79 | |
| michael@0 | 80 | /** |
| michael@0 | 81 | * Hours to skip fetching. This field was supposed to designate |
| michael@0 | 82 | * intervals for feed fetching. It's not generally implemented. See |
| michael@0 | 83 | * <http://blogs.law.harvard.edu/tech/rss> for more information. |
| michael@0 | 84 | */ |
| michael@0 | 85 | attribute nsIArray skipHours; |
| michael@0 | 86 | }; |
