FoodCandy!

RssFeed Class Reference

The contents of a RssFeed. More...

List of all members.


Public Member Functions

 RssFeed ()
 Initialize a new instance of the RssFeed class.
 RssFeed (Encoding encoding)
 Initialize a new instance of the RssFeed class with a specified encoding.
override string ToString ()
 Returns a string representation of the current Object.
void Write (Stream stream)
 Writes the RSS feed to the specified stream.
void Write (string fileName)
 Writes the RSS feed to the specified file.

Static Public Member Functions

static RssFeed Read (string url)
 Reads the specified RSS feed.
static RssFeed Read (HttpWebRequest Request)
 Reads the specified RSS feed.
static RssFeed Read (Stream stream)
 Reads the specified RSS feed.
static RssFeed Read (TextReader tr)
 Reads the specified RSS feed.
static RssFeed Read (RssFeed oldFeed)
 Reads the specified RSS feed.
static RssFeed Read (HttpWebRequest Request, RssFeed oldFeed)
 Reads the specified RSS feed.

Properties

RssChannelCollection Channels
 The channels that are contained in the feed.
RssModuleCollection Modules
 The modules that the feed adhears to.
ExceptionCollection Exceptions
 A collection of all exceptions encountered during the reading of the feed.
RssVersion Version
 The Version of the feed.
string ETag
 The server generated hash of the feed.
DateTime LastModified
 The server generated last modfified date and time of the feed.
bool Cached
 Indicates this feed has not been changed on the server, and the local copy was returned.
string Url
 Location of the feed.
Encoding Encoding
 Encoding of the feed.

Detailed Description

The contents of a RssFeed.


Member Function Documentation

static RssFeed Read HttpWebRequest  Request,
RssFeed  oldFeed
[static]
 

Reads the specified RSS feed.

Parameters:
Request The specified way to connect to the web server
oldFeed The cached version of the feed
Returns:
The current contents of the feed
Will not download the feed if it has not been modified

static RssFeed Read RssFeed  oldFeed  )  [static]
 

Reads the specified RSS feed.

Parameters:
oldFeed The cached version of the feed
Returns:
The current contents of the feed
Will not download the feed if it has not been modified

static RssFeed Read TextReader  tr  )  [static]
 

Reads the specified RSS feed.

Returns:
The contents of the feed

static RssFeed Read Stream  stream  )  [static]
 

Reads the specified RSS feed.

Returns:
The contents of the feed

static RssFeed Read HttpWebRequest  Request  )  [static]
 

Reads the specified RSS feed.

Parameters:
Request The specified way to connect to the web server
Returns:
The contents of the feed

static RssFeed Read string  url  )  [static]
 

Reads the specified RSS feed.

Parameters:
url The url or filename of the RSS feed
Returns:
The contents of the feed

override string ToString  ) 
 

Returns a string representation of the current Object.

Returns:
The Url of the feed

void Write string  fileName  ) 
 

Writes the RSS feed to the specified file.

The encoding is ISO-8859-1.

Exceptions:
ArgumentException The filename is empty, contains only white space, or contains one or more invalid characters.
UnauthorizedAccessException Access is denied.
ArgumentNullException The filename is a (null c#, Nothing vb) reference.
DirectoryNotFoundException The directory to write to is not found.
IOException The filename includes an incorrect or invalid syntax for file name, directory name, or volume label syntax.
System.Security.SecurityException The caller does not have the required permission.
Parameters:
fileName specified file (including path) If the file exists, it will be truncated with the new content.
Exceptions:
InvalidOperationException Feed must contain at least one channel.
InvalidOperationException Channel must contain at least one item.

void Write Stream  stream  ) 
 

Writes the RSS feed to the specified stream.

Parameters:
stream specified Stream
Exceptions:
ArgumentException The Stream cannot be written to.
InvalidOperationException Feed must contain at least one channel.
InvalidOperationException Channel must contain at least one item.

The documentation for this class was generated from the following file:
  • RssFeed.cs
© FoodCandy, 2006-2007, All Rights Reserved | FoodCandy | Sun Oct 7 10:48:52 2007 | Doxygen 1.4.6-NO