summaryrefslogtreecommitdiffstats
path: root/toolkit/components/feeds/nsIFeedEntry.idl
blob: 83646aadb60382a19f2fcbbe4dcf4d080aa83fb0 (plain)
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 "nsIFeedContainer.idl"
interface nsIArray;

/**
 * An nsIFeedEntry represents an Atom or RSS entry/item. Summary
 * and/or full-text content may be available, but callers will have to
 * check both.
 */
[scriptable, uuid(31bfd5b4-8ff5-4bfd-a8cb-b3dfbd4f0a5b)]
interface nsIFeedEntry : nsIFeedContainer {

  /**
  * Uses description, subtitle, summary, content and extensions
  * to generate a summary. 
  * 
  */
  attribute nsIFeedTextConstruct summary;

  /**
   * The date the entry was published, in RFC822 form. Parsable by JS
   * and mail code.
   */
  attribute AString published;

  /**
  * Uses atom:content and content:encoded to provide
  * a 'full text' view of an entry.
  *
  */
  attribute nsIFeedTextConstruct content;

  /**
  * Enclosures are podcasts, photocasts, etc.
  */
  attribute nsIArray enclosures;

  /**
  * Enclosures, etc. that might be displayed inline.
  */
  attribute nsIArray mediaContent;
};