users.tpryan.rss.rss
Component rss



hierarchy: WEB-INF.cftags.component
      users.tpryan.rss.rss
path: rss.cfc
properties:
methods: addCategoryToFeed, addCategoryToItem, addEnclosureToItem, addItem, addSkipDayToFeed, addSkipHourToFeed, create, getFeed, init
* - private method

addCategoryToFeed
public void addCategoryToFeed ( required string category, string domain="" )

Output: suppressed
Parameters:
   category: string, required, category - The name of the category to add.
   domain: string, optional, domain - a string that identifies the taxonomy you are using.

addCategoryToItem
public void addCategoryToItem ( any item="", required string category, string domain="" )

Output: suppressed
Parameters:
   item: any, optional, item - The item to add the category to. Defaults to last item added.
   category: string, required, category - The name of the category to add.
   domain: string, optional, domain - a string that identifies the taxonomy you are using.

addEnclosureToItem
public void addEnclosureToItem ( any item="", required string url, required string length, required string type )

Output: suppressed
Parameters:
   item: any, optional, item - The item to add the enclosure to. Defaults to last item added.
   url: string, required, url - The url of the item added.
   length: string, required, length - The length in bytes of the item.
   type: string, required, type - The MIME type of the item.

addItem
public void addItem ( string title="", string description="", string link="", string author="", any pubDate="", string guid="", string comments="" )

Output: suppressed
Parameters:
   title: string, optional, title - The title of the item to add to the feed.
   description: string, optional, description - The description of the rss channel to create.
   link: string, optional, link - The url to associate with this item.
   author: string, optional, author - The author of this item.
   pubDate: any, optional, pubDate - The date this item was published.
   guid: string, optional, guid - A Guid for keeping track of items.
   comments: string, optional, comments - A URL pointing to the comments page of the item.

addSkipDayToFeed
public void addSkipDayToFeed ( required string dayToSkip )

Output: suppressed
Parameters:
   dayToSkip: string, required, dayToSkip - The day of the week to skip in full string format: eg. Wednesday.

addSkipHourToFeed
public void addSkipHourToFeed ( required numeric hourToSkip )

Output: suppressed
Parameters:
   hourToSkip: numeric, required, hourToSkip - The number of the hour to skip 0-23

create
public void create ( required string title, required string description, required string link, string language="", any pubDate="[runtime expression]", any lastBuildDate="[runtime expression]", string copyright="", string managingEditor="", string webMaster="", string generator="", string docs="http://blogs.law.harvard.edu/tech/rss", any ttl="", string image="", any rating="" )

Output: suppressed
Parameters:
   title: string, required, title - The title of the rss channel to create.
   description: string, required, description - The description of the rss channel to create.
   link: string, required, link - The url to associate with the rss feed. Usually the site's url.
   language: string, optional, language - The language in which this feed is written.
   pubDate: any, optional, pubDate - The date of publication for this feed.
   lastBuildDate: any, optional, lastBuildDate - The date of last update for this feed.
   copyright: string, optional, copyright - Copyright notice for content in the channel.
   managingEditor: string, optional, managingEditor - Email address for person responsible for editorial content.
   webMaster: string, optional, webMaster - Email address for person responsible for technical issues relating to channel.
   generator: string, optional, generator - A string indicating the program used to generate the channel.
   docs: string, optional, docs - A URL that points to the documentation for the format used in the RSS file.
   ttl: any, optional, ttl - Time To Live, in seconds.
   image: string, optional, image - Specifies a GIF, JPEG or PNG image that can be displayed with the channel.
   rating: any, optional, rating - The PICS rating for the channel.

getFeed
public string getFeed ( )

Output: suppressed

init
public init ( )

Output: suppressed