SyndicationPerson Class

Definition

Represents an author or contributor of syndication content.

public ref class SyndicationPerson
public class SyndicationPerson
type SyndicationPerson = class
Public Class SyndicationPerson
Inheritance
SyndicationPerson

Examples

The following code shows how to add a SyndicationPerson to the authors collection of a SyndicationFeed instance.

SyndicationFeed feed = new SyndicationFeed("Feed Title", "Feed Description", new Uri("http://Feed/Alternate/Link"), "FeedID", DateTime.Now);
SyndicationPerson sp = new SyndicationPerson("jesper@contoso.com", "Jesper Aaberg", "http://Jesper/Aaberg");
feed.Authors.Add(sp);
Dim feed As New SyndicationFeed("Feed Title", "Feed Description", New Uri("http://Feed/Alternate/Link"), "FeedID", DateTime.Now)
Dim sp As New SyndicationPerson("jesper@contoso.com", "Jesper Aaberg", "http://Jesper/Aaberg")
feed.Authors.Add(sp)

The following XML shows how a SyndicationPerson is serialized to Atom 1.0.

<author>
  <name>Jesper Aaberg</name>
  <uri>http://Jesper/Aaberg</uri>
  <email>Jesper.Aaberg@contoso.com</email>
</author>
<contributor>
  <name>Lene Aalling</name>
  <uri>http://Lene/Aaling</uri>
  <email>Lene.Aaling@contoso.com</email>
</contributor>

The following XML shows how a SyndicationPerson is serialized to RSS 2.0.

<a10:author>
  <a10:name>Lene Aalling</a10:name>
  <a10:uri>http://Lene/Aalling</a10:uri>
  <a10:email>Lene.Aalling@contoso.com</a10:email>
</a10:author>
  <a10:contributor>
  <a10:name>Jesper Aaberg</a10:name>
  <a10:uri>http://Jesper/Aaberg</a10:uri>
  <a10:email>Jesper.Aaberg@contoso.com</a10:email>
</a10:contributor>

Remarks

SyndicationPerson objects can be added to the authors and contributors collections on SyndicationFeed and SyndicationItem objects.

When serialized to Atom 1.0, the SyndicationPerson is written out as an <author> or <contributor> element.

When serialized to RSS 2.0, a SyndicationPerson instance is written out as a <managingEditor>, <a10:author>, or <a10:contributor> element. How a SyndicationPerson is serialized depends on the number of SyndicationPerson objects added to a SyndicationFeed or SyndicationItem, which collection the SyndicationPerson instances are added to, and the value of the SerializeExtensionAsAtom parameter to the Rss20ItemFormatter(SyndicationItem, Boolean) constructor. If only one SyndicationPerson is added to the Authors (or Authors) collection, the SyndicationPerson is serialized to a <managingEditor> element. If more than one SyndicationPerson is added to the Authors (or Authors) collection and SerializeExtensionsAsAtom is set to true, all of the SyndicationPerson objects are serialized to <a10:author> elements. If SerializeExtensionsAsAtom is set to false, the SyndicationPerson instances is not serialized. Any SyndicationPerson instances added to the Contributors (or Contributors) collection are only serialized if SerializeExtensionsAsAtom is set to true, in which case they are serialized to <a10:contributor> elements.

Constructors

SyndicationPerson()

Initializes a new SyndicationPerson instance.

SyndicationPerson(String)

Initializes a new SyndicationPerson instance with the specified email address.

SyndicationPerson(String, String, String)

Initializes a new SyndicationPerson instance with the specified email address, name, and Uniform Resource Identifier (URI).

SyndicationPerson(SyndicationPerson)

Initializes a new instance of the SyndicationPerson class with the specified instance.

Properties

AttributeExtensions

Gets the attribute extensions for the SyndicationPerson.

ElementExtensions

Gets the element extensions for the SyndicationPerson.

Email

Gets or sets the email address of the SyndicationPerson.

Name

Gets or sets the name of the SyndicationPerson.

Uri

Gets or sets the URI of the SyndicationPerson.

Methods

Clone()

Creates a copy of the existing SyndicationPerson instance.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
TryParseAttribute(String, String, String, String)

Attempts to parse an attribute extension.

TryParseElement(XmlReader, String)

Attempts to parse an element extension.

WriteAttributeExtensions(XmlWriter, String)

Writes the attribute extensions to the specified XmlWriter using the specified syndication version.

WriteElementExtensions(XmlWriter, String)

Writes the element extensions to the specified XmlWriter using the specified syndication version.

Applies to