The Tor Browser / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/toolkit/components/feeds/nsIFeed.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,86 @@
     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 +
    1.11 +interface nsIArray;
    1.12 +interface nsIFeedGenerator;
    1.13 +
    1.14 +/**
    1.15 + * An nsIFeed represents a single Atom or RSS feed.
    1.16 + */
    1.17 +[scriptable, uuid(3b8aae33-80e2-4efa-99c8-a6c5b99f76ea)]
    1.18 +interface nsIFeed : nsIFeedContainer
    1.19 +{
    1.20 +  /** 
    1.21 +  * Uses description, subtitle, and extensions
    1.22 +  * to generate a summary. 
    1.23 +  */
    1.24 +  attribute nsIFeedTextConstruct subtitle;
    1.25 +
    1.26 +  // All content classifies as a "feed" - it is the transport.
    1.27 +  const unsigned long TYPE_FEED = 0;
    1.28 +  const unsigned long TYPE_AUDIO = 1;
    1.29 +  const unsigned long TYPE_IMAGE = 2;
    1.30 +  const unsigned long TYPE_VIDEO = 4;
    1.31 +
    1.32 +  /**
    1.33 +  * The type of feed. For example, a podcast would be TYPE_AUDIO.
    1.34 +  */
    1.35 +  readonly attribute unsigned long type;
    1.36 +  
    1.37 +  /**
    1.38 +  * The total number of enclosures found in the feed.
    1.39 +  */
    1.40 +  attribute long enclosureCount;
    1.41 +
    1.42 +  /**
    1.43 +  * The items or entries in feed.
    1.44 +  */
    1.45 +  attribute nsIArray items;
    1.46 +
    1.47 +  /**
    1.48 +  * No one really knows what cloud is for.
    1.49 +  *
    1.50 +  * It supposedly enables some sort of interaction with an XML-RPC or
    1.51 +  * SOAP service.
    1.52 +  */
    1.53 +  attribute nsIWritablePropertyBag2 cloud;
    1.54 +
    1.55 +  /**
    1.56 +  * Information about the software that produced the feed.
    1.57 +  */
    1.58 +  attribute nsIFeedGenerator generator;
    1.59 +
    1.60 +  /**
    1.61 +  * An image url and some metadata (as defined by RSS2).
    1.62 +  *
    1.63 +  */
    1.64 +  attribute nsIWritablePropertyBag2 image;
    1.65 +
    1.66 +  /**
    1.67 +  * No one really knows what textInput is for.
    1.68 +  *
    1.69 +  * See
    1.70 +  * <http://www.cadenhead.org/workbench/news/2894/rss-joy-textinput>
    1.71 +  * for more details.
    1.72 +  */
    1.73 +  attribute nsIWritablePropertyBag2 textInput;
    1.74 +
    1.75 +  /**
    1.76 +  * Days to skip fetching. This field was supposed to designate
    1.77 +  * intervals for feed fetching. It's not generally implemented. For
    1.78 +  * example, if this array contained "Monday", aggregators should not
    1.79 +  * fetch the feed on Mondays.
    1.80 +  */
    1.81 +  attribute nsIArray skipDays;
    1.82 +
    1.83 + /**
    1.84 +  * Hours to skip fetching. This field was supposed to designate
    1.85 +  * intervals for feed fetching. It's not generally implemented. See
    1.86 +  * <http://blogs.law.harvard.edu/tech/rss> for more information.
    1.87 +  */
    1.88 +  attribute nsIArray skipHours;
    1.89 +};