SyndicationFeed SyndicationFeed SyndicationFeed 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
- Attributes
| 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.
| SyndicationFeed | RSS Channel | Atom Feed |
|---|---|---|
| Authors | managingEditor | author |
| Categories | category | category |
| Contributors | contributor | |
| Generator | generator | generator |
| IconUri | icon | |
| Id | id | |
| LastUpdatedTime | lastBuildDate | updated |
| Rights | copyright | rights |
| Subtitle | description | subtitle |
| Title | title | title |
| Items | item | entry |
| Links | link | link |
| ImageUri | image | logo |
| 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()
Creates a new SyndicationFeed object.
public SyndicationFeed()public SyndicationFeed()Public Sub New()
- Attributes
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(String title, String subtitle, Uri uri)public SyndicationFeed(String title, String subtitle, Uri uri)Public Sub New(title As String, subtitle As String, uri As Uri)
- title
- System.String System.String System.String
The Title of the syndication feed.
- subtitle
- System.String System.String System.String
The Subtitle of the syndication feed.
- Attributes
Properties
AttributeExtensions AttributeExtensions AttributeExtensions
Gets the list of custom attributes of the element.
public IVector<SyndicationAttribute> AttributeExtensions { get; }public IVector<SyndicationAttribute> AttributeExtensions { get; }Public ReadOnly Property AttributeExtensions As IVector<SyndicationAttribute>
- Value
A list of attributes of the element.
- Attributes
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 IVector<SyndicationPerson> Authors { get; }Public ReadOnly Property Authors As IVector<SyndicationPerson>
- Value
The collection of all the atom:author elements under atom:entry.
- Attributes
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
- Attributes
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 IVector<SyndicationCategory> Categories { get; }Public ReadOnly Property Categories As IVector<SyndicationCategory>
- Value
The collection of all atom:category elements under atom:feed.
- Attributes
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 IVector<SyndicationPerson> Contributors { get; }Public ReadOnly Property Contributors As IVector<SyndicationPerson>
- Value
The collection of all atom:contributor elements under atom:feed.
- Attributes
ElementExtensions ElementExtensions ElementExtensions
Gets the list of child elements within the element.
public IVector<ISyndicationNode> ElementExtensions { get; }public IVector<ISyndicationNode> ElementExtensions { get; }Public ReadOnly Property ElementExtensions As IVector<ISyndicationNode>
- Value
The list of child elements within the element.
- Attributes
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
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
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.
- Attributes
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
The atom:generator element or the generator element in RSS 2.0.
- Attributes
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
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.
- Attributes
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
- Value
- string string string
The atom:Id element or the guid element in RSS 2.0.
- Attributes
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
- Attributes
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 IVector<SyndicationItem> Items { get; }Public ReadOnly Property Items As IVector<SyndicationItem>
- Value
The collection of atom:entry elements or a collection of item elements in RSS 2.0.
- Attributes
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
- Value
- string string string
The xml:lang attribute on the element.
- Attributes
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
- Attributes
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
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.
- Attributes
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 IVector<SyndicationLink> Links { get; }Public ReadOnly Property Links As IVector<SyndicationLink>
- Value
A collection of the atom:link elements under atom:feed. In RSS 2.0 this maps to the link element.
- Attributes
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
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.
- Attributes
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
- Value
- string string string
The local name of the element. Must be valid according to XML 1.0.
- Attributes
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
- Value
- string string string
The namespace of the element.
- Attributes
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
- Value
- string string string
The text content of the element.
- Attributes
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
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.
- Attributes
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
The atom:rights element or the copyright element in RSS 2.0.
- Attributes
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
The format of the source document or SyndicationFormat_Atom10.
- Attributes
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
The atom:subtitle element or the description element in RSS 2.0.
- Attributes
Methods
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
The format of the data.
The DOM object that represents this element, and all the attributes and child elements, including foreign markups.
- Attributes
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(String feed)public void Load(String feed)Public Function Load(feed As String) As void
- feed
- System.String System.String System.String
The feed string, which can be in either RSS 2.0 or Atom 1.0 format.
- Attributes
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
- feedDocument
- XmlDocument XmlDocument XmlDocument
The DOM object which contains XML content in either RSS 2.0 or Atom 1.0 format.
- Attributes