Syndication​Feed Syndication​Feed Syndication​Feed Syndication​Feed Class

Definition

Contains information about a feed. This class encapsulates the information in the /rss/channel element in RSS 2.0 or the atom:feed element in Atom 1.0.

public : sealed class SyndicationFeed : ISyndicationFeed, ISyndicationNodepublic sealed class SyndicationFeed : ISyndicationFeed, ISyndicationNodePublic NotInheritable Class SyndicationFeed Implements ISyndicationFeed, ISyndicationNode// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The following table maps SyndicationFeed properties to RSS and Atom feed elements.

SyndicationFeedRSS ChannelAtom Feed
Authors managingEditorauthor
Categories categorycategory
Contributors contributor
Generator generatorgenerator
IconUri icon
Id id
LastUpdatedTime lastBuildDateupdated
Rights copyrightrights
Subtitle descriptionsubtitle
Title titletitle
Items itementry
Links linklink
ImageUri imagelogo
FirstUri link with rel="first"
LastUri link with rel="last"
NextUri link with rel="next"
PreviousUri link with rel="previous"
SourceFormat

Constructors

SyndicationFeed() SyndicationFeed() SyndicationFeed() SyndicationFeed()

Creates a new SyndicationFeed object.

public : SyndicationFeed()public SyndicationFeed()Public Sub New()// You can use this method in JavaScript.
See Also

SyndicationFeed(String, String, Uri) SyndicationFeed(String, String, Uri) SyndicationFeed(String, String, Uri) SyndicationFeed(String, String, Uri)

Creates a new SyndicationFeed object with a Title, Subtitle, and Uri.

public : SyndicationFeed(PlatForm::String title, PlatForm::String subtitle, Uri uri)public SyndicationFeed(String title, String subtitle, Uri uri)Public Sub New(title As String, subtitle As String, uri As Uri)// You can use this method in JavaScript.
Parameters
title
PlatForm::String String String String

The Title of the syndication feed.

subtitle
PlatForm::String String String String

The Subtitle of the syndication feed.

uri
Uri Uri Uri Uri

The Uri value.

Properties

AttributeExtensions AttributeExtensions AttributeExtensions AttributeExtensions

Gets the list of custom attributes of the element.

public : IVector<SyndicationAttribute> AttributeExtensions { get; }public IList<SyndicationAttribute> AttributeExtensions { get; }Public ReadOnly Property AttributeExtensions As IList<SyndicationAttribute>// You can use this property in JavaScript.
Value
IVector<SyndicationAttribute> IList<SyndicationAttribute> IList<SyndicationAttribute> IList<SyndicationAttribute>

A list of attributes of the element.

Authors Authors Authors Authors

Gets the authors of an item. This property represents the collection of all the atom:author elements under atom:entry.

public : IVector<SyndicationPerson> Authors { get; }public IList<SyndicationPerson> Authors { get; }Public ReadOnly Property Authors As IList<SyndicationPerson>// You can use this property in JavaScript.
Value
IVector<SyndicationPerson> IList<SyndicationPerson> IList<SyndicationPerson> IList<SyndicationPerson>

The collection of all the atom:author elements under atom:entry.

BaseUri BaseUri BaseUri BaseUri

Gets or sets the base URI for the element. This property represents the xml:base attribute on the element. It may be inherited from an ancestor element.

public : Uri BaseUri { get; set; }public Uri BaseUri { get; set; }Public ReadWrite Property BaseUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The xml:base attribute on the element.

Categories Categories Categories Categories

Gets a collection of categories of the feed. This property represents the collection of all the atom:category elements under atom:feed.

public : IVector<SyndicationCategory> Categories { get; }public IList<SyndicationCategory> Categories { get; }Public ReadOnly Property Categories As IList<SyndicationCategory>// You can use this property in JavaScript.
Value
IVector<SyndicationCategory> IList<SyndicationCategory> IList<SyndicationCategory> IList<SyndicationCategory>

The collection of all atom:category elements under atom:feed.

Contributors Contributors Contributors Contributors

Gets a collection of the contributors of the feed. This property represents the collection of all the atom:contributor elements under atom:feed.

public : IVector<SyndicationPerson> Contributors { get; }public IList<SyndicationPerson> Contributors { get; }Public ReadOnly Property Contributors As IList<SyndicationPerson>// You can use this property in JavaScript.
Value
IVector<SyndicationPerson> IList<SyndicationPerson> IList<SyndicationPerson> IList<SyndicationPerson>

The collection of all atom:contributor elements under atom:feed.

ElementExtensions ElementExtensions ElementExtensions ElementExtensions

Gets the list of child elements within the element.

public : IVector<ISyndicationNode> ElementExtensions { get; }public IList<ISyndicationNode> ElementExtensions { get; }Public ReadOnly Property ElementExtensions As IList<ISyndicationNode>// You can use this property in JavaScript.
Value
IVector<ISyndicationNode> IList<ISyndicationNode> IList<ISyndicationNode> IList<ISyndicationNode>

The list of child elements within the element.

Remarks

The following elements in the RSS 2.0 documents do not have public accessors;they can be accessed by searching the ElementExtensions collection on the SyndicationFeed object:

  • /rss/channel/docs
  • /rss/channel/cloud
  • /rss/channel/pubDate
  • /rss/channel/webmaster
  • /rss/channel/ttl
  • /rss/channel/rating
  • /rss/channel/textInput
  • /rss/channel/skipDays
  • /rss/channel/skipHours

FirstUri FirstUri FirstUri FirstUri

Gets the first Uniform Resource Identifier (URI) in a sequence. This property represents the atom:link element with attribute rel=”first”.

public : Uri FirstUri { get; }public Uri FirstUri { get; }Public ReadOnly Property FirstUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:link element with attribute rel="first". This property is the absolute Uniform Resource Identifier (URI) resolved against the xml:base attribute, if it is present. If the href attribute is a relative Uniform Resource Identifier (URI) string and there is no xml:base attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Generator Generator Generator Generator

Gets or sets the generator of the feed. This property represents the atom:generator element or the generator element in RSS 2.0.

public : SyndicationGenerator Generator { get; set; }public SyndicationGenerator Generator { get; set; }Public ReadWrite Property Generator As SyndicationGenerator// You can use this property in JavaScript.
Value
SyndicationGenerator SyndicationGenerator SyndicationGenerator SyndicationGenerator

The atom:generator element or the generator element in RSS 2.0.

IconUri IconUri IconUri IconUri

Gets or sets the Uniform Resource Identifier (URI) for the image for the feed. This property represents the atom:icon element.

public : Uri IconUri { get; set; }public Uri IconUri { get; set; }Public ReadWrite Property IconUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:icon element. It is the absolute Uniform Resource Identifier (URI) resolved against the xml:base attribute, if it is present. If the href attribute is a relative Uniform Resource Identifier (URI) string and there is no xml:base attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Id Id Id Id

Gets or sets the identifier for the syndication feed.

public : PlatForm::String Id { get; set; }public string Id { get; set; }Public ReadWrite Property Id As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The atom:Id element or the guid element in RSS 2.0.

ImageUri ImageUri ImageUri ImageUri

Gets or sets the Uniform Resource Identifier (URI) of the logo for the feed. This property represents the atom:logo element or image/uri element in RSS 2.0.

public : Uri ImageUri { get; set; }public Uri ImageUri { get; set; }Public ReadWrite Property ImageUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:logo element or image/uri element in RSS 2.0.

Items Items Items Items

Gets the collection of items in the feed. This property represents the collection of atom:entry elements or a collection of item elements in RSS 2.0.

public : IVector<SyndicationItem> Items { get; }public IList<SyndicationItem> Items { get; }Public ReadOnly Property Items As IList<SyndicationItem>// You can use this property in JavaScript.
Value
IVector<SyndicationItem> IList<SyndicationItem> IList<SyndicationItem> IList<SyndicationItem>

The collection of atom:entry elements or a collection of item elements in RSS 2.0.

Language Language Language Language

Gets or sets the language of the element. This property represents the xml:lang attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

public : PlatForm::String Language { get; set; }public string Language { get; set; }Public ReadWrite Property Language As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The xml:lang attribute on the element.

LastUpdatedTime LastUpdatedTime LastUpdatedTime LastUpdatedTime

Gets or sets the time the feed was last modified. This property represents the /rss/channel/lastBuildDate or atom:updated element.

public : DateTime LastUpdatedTime { get; set; }public DateTimeOffset LastUpdatedTime { get; set; }Public ReadWrite Property LastUpdatedTime As DateTimeOffset// You can use this property in JavaScript.
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The /rss/channel/lastBuildDate or atom:updated element.

LastUri LastUri LastUri LastUri

Gets the last Uniform Resource Identifier (URI) in the sequence. This property represents the atom:link element with attribute rel=”last”.

public : Uri LastUri { get; }public Uri LastUri { get; }Public ReadOnly Property LastUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:link element with attribute rel="last". It is the absolute Uniform Resource Identifier (URI) resolved against the xml:base attribute, if it is present. If the href attribute is a relative Uniform Resource Identifier (URI) string and there is no xml:base attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Links Links Links Links

Gets the links associated with the feed. This property represents a collection of the atom:link elements under atom:feed. In RSS 2.0, this maps to the link element.

public : IVector<SyndicationLink> Links { get; }public IList<SyndicationLink> Links { get; }Public ReadOnly Property Links As IList<SyndicationLink>// You can use this property in JavaScript.
Value
IVector<SyndicationLink> IList<SyndicationLink> IList<SyndicationLink> IList<SyndicationLink>

A collection of the atom:link elements under atom:feed. In RSS 2.0 this maps to the link element.

NextUri NextUri NextUri NextUri

Gets the next Uniform Resource Identifier (URI) in the sequence. This property represents the atom:link element with attribute rel="next".

public : Uri NextUri { get; }public Uri NextUri { get; }Public ReadOnly Property NextUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:link element with attribute rel=”next”. It is the absolute Uniform Resource Identifier (URI) resolved against the xml:base attribute, if it is present. If the href attribute is a relative Uniform Resource Identifier (URI) string and there is no xml:base attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

NodeName NodeName NodeName NodeName

Gets or sets the local name of the element.

public : PlatForm::String NodeName { get; set; }public string NodeName { get; set; }Public ReadWrite Property NodeName As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The local name of the element. Must be valid according to XML 1.0.

NodeNamespace NodeNamespace NodeNamespace NodeNamespace

Gets or sets the namespace of the element.

public : PlatForm::String NodeNamespace { get; set; }public string NodeNamespace { get; set; }Public ReadWrite Property NodeNamespace As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The namespace of the element.

NodeValue NodeValue NodeValue NodeValue

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

public : PlatForm::String NodeValue { get; set; }public string NodeValue { get; set; }Public ReadWrite Property NodeValue As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The text content of the element.

PreviousUri PreviousUri PreviousUri PreviousUri

Gets the previous Uniform Resource Identifier (URI) in the sequence. This property represents the atom:link element with attribute rel="previous".

public : Uri PreviousUri { get; }public Uri PreviousUri { get; }Public ReadOnly Property PreviousUri As Uri// You can use this property in JavaScript.
Value
Uri Uri Uri Uri

The atom:link element with attribute rel=”previous”. It is the absolute Uniform Resource Identifier (URI) resolved against the xml:base attribute, if it is present. If the href attribute is a relative Uniform Resource Identifier (URI) string and there is no xml:base attribute, this property will be null because the relative Uniform Resource Identifier (URI) is not supported by the runtime Uniform Resource Identifier (URI) class.

Rights Rights Rights Rights

Gets or sets information about the rights for the feed. This property represents the atom:rights element or the copyright element in RSS 2.0.

public : ISyndicationText Rights { get; set; }public ISyndicationText Rights { get; set; }Public ReadWrite Property Rights As ISyndicationText// You can use this property in JavaScript.
Value
ISyndicationText ISyndicationText ISyndicationText ISyndicationText

The atom:rights element or the copyright element in RSS 2.0.

SourceFormat SourceFormat SourceFormat SourceFormat

Gets the format of the source document. If the object is not loaded from a document, this property will return SyndicationFormat_Atom10.

public : SyndicationFormat SourceFormat { get; }public SyndicationFormat SourceFormat { get; }Public ReadOnly Property SourceFormat As SyndicationFormat// You can use this property in JavaScript.
Value
SyndicationFormat SyndicationFormat SyndicationFormat SyndicationFormat

The format of the source document or SyndicationFormat_Atom10.

Subtitle Subtitle Subtitle Subtitle

Gets or sets the subtitle of the feed. This property represents the atom:subtitle element or the description element in RSS 2.0.

public : ISyndicationText Subtitle { get; set; }public ISyndicationText Subtitle { get; set; }Public ReadWrite Property Subtitle As ISyndicationText// You can use this property in JavaScript.
Value
ISyndicationText ISyndicationText ISyndicationText ISyndicationText

The atom:subtitle element or the description element in RSS 2.0.

Title Title Title Title

Gets or sets the title of the syndication feed.

public : ISyndicationText Title { get; set; }public ISyndicationText Title { get; set; }Public ReadWrite Property Title As ISyndicationText// You can use this property in JavaScript.

Methods

GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat)

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are Atom 1.0 and RSS 2.0.

public : XmlDocument GetXmlDocument(SyndicationFormat format)public XmlDocument GetXmlDocument(SyndicationFormat format)Public Function GetXmlDocument(format As SyndicationFormat) As XmlDocument// You can use this method in JavaScript.
Parameters
Returns

The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

Load(String) Load(String) Load(String) Load(String)

Initializes the object from the given feed string, which can be in either RSS 2.0 or Atom 1.0 format.

public : void Load(PlatForm::String feed)public void Load(String feed)Public Function Load(feed As String) As void// You can use this method in JavaScript.
Parameters
feed
PlatForm::String String String String

The feed string, which can be in either RSS 2.0 or Atom 1.0 format.

LoadFromXml(XmlDocument) LoadFromXml(XmlDocument) LoadFromXml(XmlDocument) LoadFromXml(XmlDocument)

Initializes the SyndicationFeed object from the given DOM object, which can contain XML content in either RSS 2.0 * or *Atom 1.0 format.

public : void LoadFromXml(XmlDocument feedDocument)public void LoadFromXml(XmlDocument feedDocument)Public Function LoadFromXml(feedDocument As XmlDocument) As void// You can use this method in JavaScript.
Parameters
feedDocument
XmlDocument XmlDocument XmlDocument XmlDocument

The DOM object which contains XML content in either RSS 2.0 or Atom 1.0 format.

See Also