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.

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

mercurial