IP*Works! V9

ipworks
Class RSSChannel

java.lang.Object
  extended by ipworks.RSSChannel

public class RSSChannel
extends java.lang.Object

The information about an RSS Feed as received from the server.

When an RSS feed is parsed by the component, each item is parsed into an rssitem type and other information about the feed is presented as rsschannel .

Category: The value of this field is a forward-slash-separated string that identifies a hierarchic location in a particular hierarchy. The conventions used to interpret an RSS channel's category depend upon the processor.

CategoryDomain: This field contains the URL indicating the definition of the current RSS channel's category. This points to a location that defines the category indicated by the Category field.

Copyright: This field contains the copyright information for the current RSS channel (500 char max).

Description: This field contains a textual description of the current RSS feed (Required - 500 char max).

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include the Channel 's Link , Title , and Description fields.

Docs: This should contain a URL for the documentation describing what format was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

Generator: This field contains the name of the program which created the RSS feed.

ImageDescription: This field is used to specify text that is included in the title attribute of the image's link formed in HTML rendering.

ImageHeight: This field contains the height of the image in pixels.

ImageLink: This field contains the URL associated with the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink
The link associated with the image. For graphical representations, this is the webpage that will be displayed if the image is clicked.
ImageTitle
The title of the image.
ImageUrl
URL where the image can be found.

ImageTitle: This field contains the title of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink
The link associated with the image.
ImageTitle
The title of the image.
ImageUrl
URL where the image can be found.

ImageUrl: This field contains the URL location of the channel's associated image.

Images are required for RSS channels that conform to version 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

ImageLink
The link associated with the image.
ImageTitle
The title of the image.
ImageUrl
URL where the image can be found.

ImageWidth: This field contains the width of the image in pixels.

Language: This field is required for feeds that conform to version 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Examples include:

en \011
English
en-US
English (U.S. version)
ja \011
Japanese
sq \011
Albanian
fr-ca
French (Canada)
etc...

For a detailed explanation about language codes please refer to RFC 1766.

LastBuildDate: This field contains the date of the current RSS channel's most recent content changes. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

Link: This field contains the URL that corresponds to the website where the RSS channel is located (Required - 500 char max).

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include the Channel 's Link , Title , and Description fields.

ManagingEditor: This field contains the email address or contact information for the current RSS channel's editor.

PubDate: This field contains the date of the current RSS channel's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either 2 or 4 characters long.

SkipDays: This field contains a list of days in which aggregators may skip reading the channel. When using this field, its value must contain "<day>" XML sub-elements. Each sub-element's value must be a valid day of the week, such as Monday, Tuesday, Wednesday, etc. There may be up to seven days specified for this field.

SkipHours: This field contains a list of hours in which aggregators may skip reading the channel. When using this field, its value must contain "<hour>" XML sub-elements. Each sub-element's value must be a valid hour between 0 and 23, representing a time in GMT. There may be up to 24 sub-elements specified for this field.

NOTE: Hour zero is the hour starting at midnight.

Title: This field contains the title of the current RSS Feed (Required - 40 char max). Typically the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling GetFeed .

Required fields for building RSS feeds include the Channel 's Link , Title , and Description fields.

Ttl: This field contains a number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

WebMaster: This field contains the email address or contact information for the current RSS channel's webmaster.

See Also:
Atom, Atom.RSSChannel

Constructor Summary
RSSChannel()
           
RSSChannel(java.lang.String title, java.lang.String description)
           
 
Method Summary
 java.lang.String getCategory()
           
 java.lang.String getCategoryDomain()
           
 java.lang.String getCopyright()
           
 java.lang.String getDescription()
           
 java.lang.String getDocs()
           
 java.lang.String getGenerator()
           
 java.lang.String getImageDescription()
           
 java.lang.String getImageHeight()
           
 java.lang.String getImageLink()
           
 java.lang.String getImageTitle()
           
 java.lang.String getImageUrl()
           
 java.lang.String getImageWidth()
           
 java.lang.String getLanguage()
           
 java.lang.String getLastBuildDate()
           
 java.lang.String getLink()
           
 java.lang.String getManagingEditor()
           
 java.lang.String getPubDate()
           
 java.lang.String getSkipDays()
           
 java.lang.String getSkipHours()
           
 java.lang.String getTitle()
           
 java.lang.String getTtl()
           
 java.lang.String getWebMaster()
           
 void setCategory(java.lang.String value)
           
 void setCategoryDomain(java.lang.String value)
           
 void setCopyright(java.lang.String value)
           
 void setDescription(java.lang.String value)
           
 void setDocs(java.lang.String value)
           
 void setGenerator(java.lang.String value)
           
 void setImageDescription(java.lang.String value)
           
 void setImageHeight(java.lang.String value)
           
 void setImageLink(java.lang.String value)
           
 void setImageTitle(java.lang.String value)
           
 void setImageUrl(java.lang.String value)
           
 void setImageWidth(java.lang.String value)
           
 void setLanguage(java.lang.String value)
           
 void setLastBuildDate(java.lang.String value)
           
 void setLink(java.lang.String value)
           
 void setManagingEditor(java.lang.String value)
           
 void setPubDate(java.lang.String value)
           
 void setSkipDays(java.lang.String value)
           
 void setSkipHours(java.lang.String value)
           
 void setTitle(java.lang.String value)
           
 void setTtl(java.lang.String value)
           
 void setWebMaster(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RSSChannel

public RSSChannel()

RSSChannel

public RSSChannel(java.lang.String title,
                  java.lang.String description)
Method Detail

getCategory

public java.lang.String getCategory()

setCategory

public void setCategory(java.lang.String value)

getCategoryDomain

public java.lang.String getCategoryDomain()

setCategoryDomain

public void setCategoryDomain(java.lang.String value)

getCopyright

public java.lang.String getCopyright()

setCopyright

public void setCopyright(java.lang.String value)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String value)

getDocs

public java.lang.String getDocs()

setDocs

public void setDocs(java.lang.String value)

getGenerator

public java.lang.String getGenerator()

setGenerator

public void setGenerator(java.lang.String value)

getImageDescription

public java.lang.String getImageDescription()

setImageDescription

public void setImageDescription(java.lang.String value)

getImageHeight

public java.lang.String getImageHeight()

setImageHeight

public void setImageHeight(java.lang.String value)

getImageLink

public java.lang.String getImageLink()

setImageLink

public void setImageLink(java.lang.String value)

getImageTitle

public java.lang.String getImageTitle()

setImageTitle

public void setImageTitle(java.lang.String value)

getImageUrl

public java.lang.String getImageUrl()

setImageUrl

public void setImageUrl(java.lang.String value)

getImageWidth

public java.lang.String getImageWidth()

setImageWidth

public void setImageWidth(java.lang.String value)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String value)

getLastBuildDate

public java.lang.String getLastBuildDate()

setLastBuildDate

public void setLastBuildDate(java.lang.String value)

getLink

public java.lang.String getLink()

setLink

public void setLink(java.lang.String value)

getManagingEditor

public java.lang.String getManagingEditor()

setManagingEditor

public void setManagingEditor(java.lang.String value)

getPubDate

public java.lang.String getPubDate()

setPubDate

public void setPubDate(java.lang.String value)

getSkipDays

public java.lang.String getSkipDays()

setSkipDays

public void setSkipDays(java.lang.String value)

getSkipHours

public java.lang.String getSkipHours()

setSkipHours

public void setSkipHours(java.lang.String value)

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String value)

getTtl

public java.lang.String getTtl()

setTtl

public void setTtl(java.lang.String value)

getWebMaster

public java.lang.String getWebMaster()

setWebMaster

public void setWebMaster(java.lang.String value)

IP*Works! V9

Copyright (c) 2013 /n software inc. - All rights reserved.