toolkit/components/feeds/nsIFeedEntry.idl@925c144e1f1f (annotated)
toolkit/components/feeds/nsIFeedEntry.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 | interface nsIArray; |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * An nsIFeedEntry represents an Atom or RSS entry/item. Summary |
| michael@0 | 11 | * and/or full-text content may be available, but callers will have to |
| michael@0 | 12 | * check both. |
| michael@0 | 13 | */ |
| michael@0 | 14 | [scriptable, uuid(31bfd5b4-8ff5-4bfd-a8cb-b3dfbd4f0a5b)] |
| michael@0 | 15 | interface nsIFeedEntry : nsIFeedContainer { |
| michael@0 | 16 | |
| michael@0 | 17 | /** |
| michael@0 | 18 | * Uses description, subtitle, summary, content and extensions |
| michael@0 | 19 | * to generate a summary. |
| michael@0 | 20 | * |
| michael@0 | 21 | */ |
| michael@0 | 22 | attribute nsIFeedTextConstruct summary; |
| michael@0 | 23 | |
| michael@0 | 24 | /** |
| michael@0 | 25 | * The date the entry was published, in RFC822 form. Parsable by JS |
| michael@0 | 26 | * and mail code. |
| michael@0 | 27 | */ |
| michael@0 | 28 | attribute AString published; |
| michael@0 | 29 | |
| michael@0 | 30 | /** |
| michael@0 | 31 | * Uses atom:content and content:encoded to provide |
| michael@0 | 32 | * a 'full text' view of an entry. |
| michael@0 | 33 | * |
| michael@0 | 34 | */ |
| michael@0 | 35 | attribute nsIFeedTextConstruct content; |
| michael@0 | 36 | |
| michael@0 | 37 | /** |
| michael@0 | 38 | * Enclosures are podcasts, photocasts, etc. |
| michael@0 | 39 | */ |
| michael@0 | 40 | attribute nsIArray enclosures; |
| michael@0 | 41 | |
| michael@0 | 42 | /** |
| michael@0 | 43 | * Enclosures, etc. that might be displayed inline. |
| michael@0 | 44 | */ |
| michael@0 | 45 | attribute nsIArray mediaContent; |
| michael@0 | 46 | }; |
