Atom::Core::AtomFeed

AtomFeed Class Reference

The Atom feed.

See also:: AtomEntry

Inheritance diagram for AtomFeed:


Public Member Functions
	AtomFeed (Uri ns)
	Initialize a new instance of the AtomFeed class.
override string	ToString ()
	Converts the AtomEntry in a series of xml nodes.
void	Save (Stream stream)
	Saves the AtomFeed to the specified Stream.
void	Save (string filename)
	Saves the AtomFeed to the specified filename.
void	Save (TextWriter tw)
	Saves the AtomFeed to the specified TextWriter.
void	Save (XmlWriter xw)
	Saves the AtomFeed to the specified TextWriter.
void	Save (WebResponse response)
	Saves the AtomFeed to the specified HttpWebResponse.
Static Public Member Functions
static AtomFeed	Load (string uri, Uri ns)
	Loads the AtomFeed from the specified URI.
static AtomFeed	Load (Uri uri, Uri ns)
	Loads the AtomFeed from the specified System.Uri.
static AtomFeed	Load (Stream stream, Uri ns)
	Loads the AtomFeed from the specified Stream.
static AtomFeed	Load (TextReader tr, Uri ns)
	Loads the AtomFeed from the specified TextReader.
static AtomFeed	Load (WebRequest request, Uri ns)
	Loads the AtomFeed from the specified HttpWebRequest.
static AtomFeed	Load (XmlReader reader, Uri ns)
	Loads the AtomFeed from the specified XmlReader.
static AtomFeed	LoadXml (string xmlFragment, Uri ns)
	Loads the AtomFeed from the specified xml fragment.
Properties
string	Version `[get]`
	Gets the version of the Atom specification.
AtomContentConstruct	Title `[get, set]`
	Gets or sets the title of the feed.
AtomLinkCollection	Links `[get]`
	Gets the links of the feed.
AtomPersonConstruct	Author `[get, set]`
	Gets or sets the author of the feed.
AtomPersonConstructCollection	Contributors `[get]`
	Gets the contributors of the feed.
AtomContentConstruct	Tagline `[get, set]`
	Gets or sets tagline of the feed.
AtomContentConstruct	SubTitle `[get, set]`
	Gets or sets the subtitle of the feed.
Uri	Id `[get, set]`
	Gets or sets the global unique identifier of the feed.
AtomContentConstruct	Copyright `[get, set]`
	Gets or sets the copyright of the feed.
AtomContentConstruct	Info `[get, set]`
	Gets or sets the info of the feed.
AtomDateConstruct	Modified `[get, set]`
	Gets or sets last time when the feed has been modified.
AtomEntryCollection	Entries `[get]`
	Gets the entries of the feed.
Encoding	Encoding `[get, set]`
	Gets or sets the encoding of the feed.
ScopedElementCollection	AdditionalElements `[get]`
	Gets the additional elements of the feed.
override string	LocalName `[get]`
	Gets the local name of the xml feed element.
Uri	Uri `[get, set]`
	Gets or sets the uri of the atom feed if available, otherwise return null.

Detailed Description

The Atom feed.

See also:: AtomEntry

Constructor & Destructor Documentation

AtomFeed ( Uri ns )

Initialize a new instance of the AtomFeed class.

Member Function Documentation

override string ToString ( )

Converts the AtomEntry in a series of xml nodes.

Returns:: The string representation of AtomEntry class.

void Save ( Stream stream )

Saves the AtomFeed to the specified Stream.

Parameters:

stream

The Stream to write to.

Exceptions:

	ArgumentException	The encoding is not supported or the stream cannot be written to.
	ArgumentNullException	stream is null.
	RequiredElementNotFoundException	A required element is not found.
	InvalidOperationException	The internal writ

void Save ( string filename )

Saves the AtomFeed to the specified filename.

Exceptions:

	ArgumentException	The encoding is not supported; 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 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

The file name to write to.

void Save ( TextWriter tw )

Saves the AtomFeed to the specified TextWriter.

Parameters:

The TextWriter to write to.

void Save ( XmlWriter xw )

Saves the AtomFeed to the specified TextWriter.

Parameters:

The XmlWriter to write to.

void Save ( WebResponse response )

Saves the AtomFeed to the specified HttpWebResponse.

Parameters:

response

The WebResponse to write to.

static AtomFeed Load	(	string	uri,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified URI.

Returns:: An AtomFeed instance.

Parameters:

uri

The URI of the resource containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed Load	(	Uri	uri,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified System.Uri.

Returns:: An AtomFeed instance.

Parameters:

uri

The URI of the resource containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed Load	(	Stream	stream,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified Stream.

Returns:: An AtomFeed instance.

Parameters:

stream

The Stream containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed Load	(	TextReader	tr,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified TextReader.

Returns:: An AtomFeed instance.

Parameters:

The TextReader from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed Load	(	WebRequest	request,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified HttpWebRequest.

Returns:: An AtomFeed instance.

Parameters:

request

The WebRequest from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed Load	(	XmlReader	reader,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified XmlReader.

Returns:: An AtomFeed instance.

Parameters:

reader

The XmlReader from which read the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

static AtomFeed LoadXml	(	string	xmlFragment,
		Uri	ns
	)			`[static]`

Loads the AtomFeed from the specified xml fragment.

Returns:: An AtomFeed instance.

Parameters:

xmlFragment

The string containing the Atom xml data.

Exceptions:

	XmlException	Invalid xml syntax in Atom resource or uri is null.
	ArgumentException	The resource cannot be find.
	InvalidOperationException	AtomReader has been closed, and can not be read.
	FileNotFoundException	Atom xml resource not found.

Property Documentation

string Version [get]

Gets the version of the Atom specification.

AtomContentConstruct Title [get, set]

Gets or sets the title of the feed.

AtomLinkCollection Links [get]

Gets the links of the feed.

AtomPersonConstruct Author [get, set]

Gets or sets the author of the feed.

AtomPersonConstructCollection Contributors [get]

Gets the contributors of the feed.

AtomContentConstruct Tagline [get, set]

Gets or sets tagline of the feed.

AtomContentConstruct SubTitle [get, set]

Gets or sets the subtitle of the feed.

Uri Id [get, set]

Gets or sets the global unique identifier of the feed.

AtomContentConstruct Copyright [get, set]

Gets or sets the copyright of the feed.

AtomContentConstruct Info [get, set]

Gets or sets the info of the feed.

AtomDateConstruct Modified [get, set]

Gets or sets last time when the feed has been modified.

AtomEntryCollection Entries [get]

Gets the entries of the feed.

Encoding Encoding [get, set]

Gets or sets the encoding of the feed.

ScopedElementCollection AdditionalElements [get]

Gets the additional elements of the feed.

override string LocalName [get]

Gets the local name of the xml feed element.

Reimplemented from AtomElement.

Uri Uri [get, set]

Gets or sets the uri of the atom feed if available, otherwise return null.

The documentation for this class was generated from the following file:

AtomFeed.cs

AtomFeed Class Reference

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation