toolkit/components/feeds/nsIFeedEntry.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/toolkit/components/feeds/nsIFeedEntry.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,46 @@
     1.4 +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
     1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
     1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.8 +
     1.9 +#include "nsIFeedContainer.idl"
    1.10 +interface nsIArray;
    1.11 +
    1.12 +/**
    1.13 + * An nsIFeedEntry represents an Atom or RSS entry/item. Summary
    1.14 + * and/or full-text content may be available, but callers will have to
    1.15 + * check both.
    1.16 + */
    1.17 +[scriptable, uuid(31bfd5b4-8ff5-4bfd-a8cb-b3dfbd4f0a5b)]
    1.18 +interface nsIFeedEntry : nsIFeedContainer {
    1.19 +
    1.20 +  /**
    1.21 +  * Uses description, subtitle, summary, content and extensions
    1.22 +  * to generate a summary. 
    1.23 +  * 
    1.24 +  */
    1.25 +  attribute nsIFeedTextConstruct summary;
    1.26 +
    1.27 +  /**
    1.28 +   * The date the entry was published, in RFC822 form. Parsable by JS
    1.29 +   * and mail code.
    1.30 +   */
    1.31 +  attribute AString published;
    1.32 +
    1.33 +  /**
    1.34 +  * Uses atom:content and content:encoded to provide
    1.35 +  * a 'full text' view of an entry.
    1.36 +  *
    1.37 +  */
    1.38 +  attribute nsIFeedTextConstruct content;
    1.39 +
    1.40 +  /**
    1.41 +  * Enclosures are podcasts, photocasts, etc.
    1.42 +  */
    1.43 +  attribute nsIArray enclosures;
    1.44 +
    1.45 +  /**
    1.46 +  * Enclosures, etc. that might be displayed inline.
    1.47 +  */
    1.48 +  attribute nsIArray mediaContent;
    1.49 +};

mercurial