Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SyndicationPerson Class

.NET Framework 4

Represents an author or contributor of syndication content.

System.Object
  System.ServiceModel.Syndication.SyndicationPerson

Namespace:  System.ServiceModel.Syndication
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
C#
C++
F#
VB
Copy 
public class SyndicationPerson

The SyndicationPerson type exposes the following members.

  Name Description
Public method SyndicationPerson() Initializes a new SyndicationPerson instance.
Public method SyndicationPerson(String) Initializes a new SyndicationPerson instance with the specified e-mail address.
Protected method SyndicationPerson(SyndicationPerson) Initializes a new instance of the SyndicationPerson class with the specified instance.
Public method SyndicationPerson(String, String, String) Initializes a new SyndicationPerson instance with the specified e-mail address, name, and Uniform Resource Identifier (URI).
Top
  Name Description
Public property AttributeExtensions Gets the attribute extensions for the SyndicationPerson.
Public property ElementExtensions Gets the element extensions for the SyndicationPerson.
Public property Email Gets and sets the e-mail address of the SyndicationPerson.
Public property Name Gets and sets the name of the SyndicationPerson.
Public property Uri Gets and sets the URI of the SyndicationPerson.
Top
  Name Description
Public method Clone Creates a copy of the existing SyndicationPerson instance.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TryParseAttribute Attempts to parse an attribute extension.
Protected method TryParseElement Attempts to parse an element extension.
Protected method WriteAttributeExtensions Writes the attribute extensions to the specified XmlWriter using the specified syndication version.
Protected method WriteElementExtensions Writes the element extensions to the specified XmlWriter using the specified syndication version.
Top

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.

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

C#
VB
Copy 

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);

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

None
Copy 

<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.

None
Copy 

<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>

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Gotcha - Author Email is in incorrect format according to W3C
I have been using the SyndicationPerson Object to add Author info to my feed.
I have found that W3C flags the output in the email tag as invalid.

Apparently the Email address is missing real name in paranthases, this is not automaticly done by the SyndicationPerson Object. ie.

name@hotmail.com (real name).

Just thought I would post this in case it helps anyone else out.
History