michael@0: /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsIFeedContainer.idl"
michael@0: 
michael@0: interface nsIArray;
michael@0: interface nsIFeedGenerator;
michael@0: 
michael@0: /**
michael@0:  * An nsIFeed represents a single Atom or RSS feed.
michael@0:  */
michael@0: [scriptable, uuid(3b8aae33-80e2-4efa-99c8-a6c5b99f76ea)]
michael@0: interface nsIFeed : nsIFeedContainer
michael@0: {
michael@0:   /** 
michael@0:   * Uses description, subtitle, and extensions
michael@0:   * to generate a summary. 
michael@0:   */
michael@0:   attribute nsIFeedTextConstruct subtitle;
michael@0: 
michael@0:   // All content classifies as a "feed" - it is the transport.
michael@0:   const unsigned long TYPE_FEED = 0;
michael@0:   const unsigned long TYPE_AUDIO = 1;
michael@0:   const unsigned long TYPE_IMAGE = 2;
michael@0:   const unsigned long TYPE_VIDEO = 4;
michael@0: 
michael@0:   /**
michael@0:   * The type of feed. For example, a podcast would be TYPE_AUDIO.
michael@0:   */
michael@0:   readonly attribute unsigned long type;
michael@0:   
michael@0:   /**
michael@0:   * The total number of enclosures found in the feed.
michael@0:   */
michael@0:   attribute long enclosureCount;
michael@0: 
michael@0:   /**
michael@0:   * The items or entries in feed.
michael@0:   */
michael@0:   attribute nsIArray items;
michael@0: 
michael@0:   /**
michael@0:   * No one really knows what cloud is for.
michael@0:   *
michael@0:   * It supposedly enables some sort of interaction with an XML-RPC or
michael@0:   * SOAP service.
michael@0:   */
michael@0:   attribute nsIWritablePropertyBag2 cloud;
michael@0: 
michael@0:   /**
michael@0:   * Information about the software that produced the feed.
michael@0:   */
michael@0:   attribute nsIFeedGenerator generator;
michael@0: 
michael@0:   /**
michael@0:   * An image url and some metadata (as defined by RSS2).
michael@0:   *
michael@0:   */
michael@0:   attribute nsIWritablePropertyBag2 image;
michael@0: 
michael@0:   /**
michael@0:   * No one really knows what textInput is for.
michael@0:   *
michael@0:   * See
michael@0:   * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput>
michael@0:   * for more details.
michael@0:   */
michael@0:   attribute nsIWritablePropertyBag2 textInput;
michael@0: 
michael@0:   /**
michael@0:   * Days to skip fetching. This field was supposed to designate
michael@0:   * intervals for feed fetching. It's not generally implemented. For
michael@0:   * example, if this array contained "Monday", aggregators should not
michael@0:   * fetch the feed on Mondays.
michael@0:   */
michael@0:   attribute nsIArray skipDays;
michael@0: 
michael@0:  /**
michael@0:   * Hours to skip fetching. This field was supposed to designate
michael@0:   * intervals for feed fetching. It's not generally implemented. See
michael@0:   * <http://blogs.law.harvard.edu/tech/rss> for more information.
michael@0:   */
michael@0:   attribute nsIArray skipHours;
michael@0: };