toolkit/components/feeds/public/nsIFeed.idl

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is the Feed Processor.
  16  *
  17  * The Initial Developer of the Original Code is Google Inc.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Ben Goodger <beng@google.com>
  23  *   Robert Sayre <sayrer@gmail.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsIFeedContainer.idl"
  40
  41 interface nsIArray;
  42 interface nsIFeedGenerator;
  43
  44 /**
  45  * An nsIFeed represents a single Atom or RSS feed.
  46  */
  47 [scriptable, uuid(3b8aae33-80e2-4efa-99c8-a6c5b99f76ea)]
  48 interface nsIFeed : nsIFeedContainer
  49 {
  50   /**
  51   * Uses description, subtitle, and extensions
  52   * to generate a summary.
  53   */
  54   attribute nsIFeedTextConstruct subtitle;
  55
  56   // All content classifies as a "feed" - it is the transport.
  57   const unsigned long TYPE_FEED = 0;
  58   const unsigned long TYPE_AUDIO = 1;
  59   const unsigned long TYPE_IMAGE = 2;
  60   const unsigned long TYPE_VIDEO = 4;
  61
  62   /**
  63   * The type of feed. For example, a podcast would be TYPE_AUDIO.
  64   */
  65   readonly attribute unsigned long type;
  66
  67   /**
  68   * The total number of enclosures found in the feed.
  69   */
  70   attribute long enclosureCount;
  71
  72   /**
  73   * The items or entries in feed.
  74   */
  75   attribute nsIArray items;
  76
  77   /**
  78   * No one really knows what cloud is for.
  79   *
  80   * It supposedly enables some sort of interaction with an XML-RPC or
  81   * SOAP service.
  82   */
  83   attribute nsIWritablePropertyBag2 cloud;
  84
  85   /**
  86   * Information about the software that produced the feed.
  87   */
  88   attribute nsIFeedGenerator generator;
  89
  90   /**
  91   * An image url and some metadata (as defined by RSS2).
  92   *
  93   */
  94   attribute nsIWritablePropertyBag2 image;
  95
  96   /**
  97   * No one really knows what textInput is for.
  98   *
  99   * See
 100   * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput>
 101   * for more details.
 102   */
 103   attribute nsIWritablePropertyBag2 textInput;
 104
 105   /**
 106   * Days to skip fetching. This field was supposed to designate
 107   * intervals for feed fetching. It's not generally implemented. For
 108   * example, if this array contained "Monday", aggregators should not
 109   * fetch the feed on Mondays.
 110   */
 111   attribute nsIArray skipDays;
 112
 113  /**
 114   * Hours to skip fetching. This field was supposed to designate
 115   * intervals for feed fetching. It's not generally implemented. See
 116   * <http://blogs.law.harvard.edu/tech/rss> for more information.
 117   */
 118   attribute nsIArray skipHours;
 119 };