Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
atomfeed - npm Package Compare versions
| <?xml version="1.0"?> | ||
| <doc> | ||
| <assembly> | ||
| <name>AtomFeed</name> | ||
| </assembly> | ||
| <members> | ||
| <member name="M:AtomFeed.Atom.Serialize(AtomFeed.Element.Feed,System.Text.Encoding)"> | ||
| <summary> | ||
| Serialize a feed to an XML document. | ||
| </summary> | ||
| <param name="feed">Feed object.</param> | ||
| <param name="encoding">XML declaration encoding.</param> | ||
| <returns></returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document string to feed instance. | ||
| </summary> | ||
| <param name="xml">XML string.</param> | ||
| <param name="strict">Strict mode. If the <c>strict</c> is <c>true</c>, the XML document syntax must be | ||
| fully compliant with the W3C validation, otherwise an exception will be thrown. If the | ||
| <c>strict</c> is <c>false</c>, those elements which are not compliant will be set to | ||
| <c>null</c> or <c>default</c>.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>xml</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.ReadOnlySpan{System.Byte},System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document buffer to feed instance. | ||
| </summary> | ||
| <param name="buffer">XML buffer.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>buffer</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <seealso cref="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.IO.Stream,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document stream to feed instance. | ||
| </summary> | ||
| <param name="stream">XML stream.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>stream</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <seealso cref="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="F:AtomFeed.Constants.AtomNamespace"> | ||
| <summary> | ||
| Atom XML namespace. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Constants.AtomMimetype"> | ||
| <summary> | ||
| Atom MIME media type. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Category"> | ||
| <summary> | ||
| Specifies a category that the feed or entry belongs to. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Term"> | ||
| <summary> | ||
| Identifies the category. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Scheme"> | ||
| <summary> | ||
| Identifies the categorization scheme via a URI. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Label"> | ||
| <summary> | ||
| Provides a human-readable label for display. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Content"> | ||
| <summary> | ||
| Content either contains, or links to, the complete content of the entry. | ||
| <para></para> | ||
| <para>In the most common case, the type attribute is either <c>text</c>, <c>html</c>, <c>xhtml</c>, | ||
| in which case the content element is defined identically to other text constructs.</para> | ||
| <para>If the <c>Src</c> attribute is present, it represents the URI of where the content | ||
| can be found. The <c>Type</c> attribute, if present, is the media type of the content.</para> | ||
| <para>Otherwise, if the <c>Type</c> attribute ends in <c>+xml</c> or <c>/xml</c>, then | ||
| an XML document of this type is contained in <c>Value</c>.</para> | ||
| <para>Otherwise, if the <c>Type</c> attribute starts with <c>text</c>, then an escaped document | ||
| of this type is contained in <c>Value</c>.</para> | ||
| <para>Otherwise, a base64 encoded document of the indicated media type is contained in <c>Value</c>.</para> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Entry"> | ||
| <summary> | ||
| An entry would be a single post on a weblog. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the entry using a universally unique and permanent URI. | ||
| Two entries in a feed can have the same value for id if they | ||
| represent the same entry at different points in time. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Contains a human-readable title for the entry. This value should not be blank. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the entry was modified. | ||
| This value need not change after a typo is fixed, only after a substantial modification. | ||
| Generally, different entries in a feed will have different updated timestamps. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Authors"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Names one author of the entry. An entry may have multiple authors. | ||
| An entry must contain at least one author unless there is an author | ||
| in the enclosing feed, or there is an author in the enclosed source. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Content"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Contains or links to the complete content of the entry. Content must be provided | ||
| if there is no alternate link, and should be provided if there is no summary. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Links"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Identifies related Web pages. The type of relation is defined by the rel attribute. | ||
| An entry is limited to one alternate per type and hreflang. An entry must contain an | ||
| alternate link if there is no content element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Summary"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Conveys a short summary, abstract, or excerpt of the entry. Summary should be provided | ||
| if there either is no content provided for the entry, or that content is not inline | ||
| (i.e., contains a src attribute), or if the content is encoded in base64. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Categories"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Specifies categories that the entry belongs to. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Contributors"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Names contributors to the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Published"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains the time of the initial creation or first availability of the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Rights"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Conveys information about rights, e.g. copyrights, held in and over the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Source"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains metadata from the source feed if this entry is a copy. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Feed"> | ||
| <summary> | ||
| Atom feed root element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the feed using a universally unique and permanent URI. If you have a long-term, | ||
| renewable lease on your Internet domain name, then you can feel free to use your website's address. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| A human-readable title for the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the feed was modified. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Entries"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Entry list of the feed. An entry would be a single post on a weblog. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Authors"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Names one author of the feed. A feed may have multiple authors. | ||
| A feed must contain at least one author unless all the entries | ||
| contain at least one author element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Links"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Identifies a related Web page. The type of relation is defined by the rel attribute. | ||
| A feed is limited to one alternate per type and hreflang. | ||
| A feed should contain a link back to the feed itself. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Categories"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Specifies a category that the feed belongs to. A feed may have multiple categories. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Contributors"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Names one contributor to the feed. A feed may have multiple contributors. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Generator"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies the software used to generate the feed, for debugging and other purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Icon"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies a small image which provides iconic visual identification for the feed. | ||
| Icons should be square. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Logo"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies a larger image which provides visual identification for the feed. | ||
| Images should be twice as wide as they are tall. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Rights"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Conveys information about rights, e.g. copyrights, held in and over the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Subtitle"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains a human-readable description or subtitle for the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Generator"> | ||
| <summary> | ||
| Identifies the software used to generate the feed, for debugging and other purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Value"> | ||
| <summary> | ||
| Name of the software. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Uri"> | ||
| <summary> | ||
| The URI of the source (typically a Web page) used to generate the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Version"> | ||
| <summary> | ||
| The version of the software. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Link"> | ||
| <summary> | ||
| Link is patterned after html's link element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Href"> | ||
| <summary> | ||
| The URI of the referenced resource (typically a Web page). | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Relation"> | ||
| <summary> | ||
| A single link relationship type. | ||
| <para></para> | ||
| It can be a full URI, or one of the following predefined values (default=<c>alternate</c>): | ||
| <list type="bullet"> | ||
| <item><term><c>alternate</c>:</term> | ||
| <description>an alternate representation of the entry or feed, for example a permalink to the | ||
| html version of the entry, or the front page of the weblog.</description></item> | ||
| <item><term><c>enclosure</c>:</term> | ||
| <description>a related resource which is potentially large and might require special | ||
| handling, for example an audio or video recording.</description></item> | ||
| <item><term><c>related</c>:</term> | ||
| <description>a document related to the entry or feed.</description></item> | ||
| <item><term><c>self</c>:</term> | ||
| <description>the feed itself.</description></item> | ||
| <item><term><c>via</c>:</term> | ||
| <description>the source of the information provided in the entry.</description></item> | ||
| </list> | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Type"> | ||
| <summary> | ||
| Indicates the media type of the resource. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.HrefLanguage"> | ||
| <summary> | ||
| Indicates the language of the referenced resource. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Title"> | ||
| <summary> | ||
| Human-readable information about the link, typically for display purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Length"> | ||
| <summary> | ||
| The length of the resource, in bytes. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Author"> | ||
| <summary> | ||
| <inheritdoc cref="T:AtomFeed.Element.Person"/> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Contributor"> | ||
| <summary> | ||
| <inheritdoc cref="T:AtomFeed.Element.Person"/> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Person"> | ||
| <summary> | ||
| <c>Author</c> and <c>Contributor</c> describe a person, corporation, or similar entity. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Name"> | ||
| <summary> | ||
| Conveys a human-readable name for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Email"> | ||
| <summary> | ||
| Contains an email address for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Uri"> | ||
| <summary> | ||
| Contains a home page for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Source"> | ||
| <summary> | ||
| Contains metadata from the source feed if the entry is a copy. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the source using a universally unique and permanent URI. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| A human-readable title for the source. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the source was modified. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Text"> | ||
| <summary> | ||
| <c>title</c>, <c>subtitle</c>, <c>summary</c>, <c>content</c>, and | ||
| <c>rights</c> contain human-readable text, usually in small quantities. | ||
| The type attribute determines how this information is encoded (default="text"). | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Text"> | ||
| <summary> | ||
| Plain text with no entity escaped html. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Html"> | ||
| <summary> | ||
| Entity escaped html. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Xhtml"> | ||
| <summary> | ||
| Inline xhtml, wrapped in a <c>div</c> element. | ||
| </summary> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML string. | ||
| </summary> | ||
| <param name="xml">XML string.</param> | ||
| <param name="strict">Strict mode. If the <c>strict</c> is <c>true</c>, the XML document syntax must be | ||
| fully compliant with the W3C validation, otherwise an exception will be thrown. If the | ||
| <c>strict</c> is <c>false</c>, those elements which are not compliant will be set to | ||
| <c>null</c> or <c>default</c>.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>xml</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.ReadOnlySpan{System.Byte},System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML buffer. | ||
| </summary> | ||
| <param name="buffer">XML buffer.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>buffer</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| <seealso cref="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.IO.Stream,System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML stream. | ||
| </summary> | ||
| <param name="stream">XML stream.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>stream</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| <seealso cref="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeEntry(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an entry node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Entry object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeText(System.Xml.XmlNode,System.Boolean)"> | ||
| <summary> | ||
| Deserialize text node in <c>title</c>, <c>summary</c>, <c>content</c>, and <c>rights</c> tags. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Text object.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeContent(System.Xml.XmlNode)"> | ||
| <summary> | ||
| Deserialize content node in <c>entry</c> element. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <returns>Content object.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializePerson(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize person node like <c>author</c> and <c>contributor</c>. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Person object. You may need to convert to <see cref="T:AtomFeed.Element.Author"/> or <see cref="T:AtomFeed.Element.Contributor"/>. | ||
| If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeLink(System.Xml.XmlNode,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize link node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Link object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeCategory(System.Xml.XmlNode,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize category node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Category object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeGenerator(System.Xml.XmlNode,System.Boolean)"> | ||
| <summary> | ||
| Deserialize generator node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Generator object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeSource(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean)"> | ||
| <summary> | ||
| Deserialize source node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Source object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="F:AtomFeed.Serialization.Serializer.TextElementNames"> | ||
| <summary> | ||
| Available XML node names for <see cref="T:AtomFeed.Element.Text"/> object. | ||
| </summary> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeFeed(AtomFeed.Element.Feed,System.Text.Encoding)"> | ||
| <summary> | ||
| Serialize a feed object to an XML document. | ||
| </summary> | ||
| <param name="feed">Feed object.</param> | ||
| <param name="encoding">The value of the encoding attribute. | ||
| <seealso cref="M:System.Xml.XmlDocument.CreateXmlDeclaration(System.String,System.String,System.String)"/></param> | ||
| <returns>The XML document object.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeEntry(AtomFeed.Element.Entry,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize entry. | ||
| </summary> | ||
| <param name="entry">Entry object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>The XML element.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeAuthors(System.Collections.Generic.List{AtomFeed.Element.Author},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize authors. | ||
| </summary> | ||
| <param name="authors">Author list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>XML element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeLinks(System.Collections.Generic.List{AtomFeed.Element.Link},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize links. | ||
| </summary> | ||
| <param name="links">Link list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Link element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeCategories(System.Collections.Generic.List{AtomFeed.Element.Category},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize categories. | ||
| </summary> | ||
| <param name="categories">Category list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Category element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeContributors(System.Collections.Generic.List{AtomFeed.Element.Contributor},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize contributors. | ||
| </summary> | ||
| <param name="contributors">Contributor list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Contributor element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeGenerator(AtomFeed.Element.Generator,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize generator. | ||
| </summary> | ||
| <param name="generator">Generator object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Generator element.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeText(AtomFeed.Element.Text,System.String,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize text to given element name. | ||
| </summary> | ||
| <param name="text">Text object.</param> | ||
| <param name="name">Element name, <c>title</c>, <c>summary</c>, <c>content</c>, or <c>rights</c>.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>The XML element.</returns> | ||
| <exception cref="T:System.NotSupportedException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeContent(AtomFeed.Element.Content,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize content of entry. | ||
| </summary> | ||
| <param name="content">Content object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Content element.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeSource(AtomFeed.Element.Source,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize source. | ||
| </summary> | ||
| <param name="source">Source object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Source element.</returns> | ||
| </member> | ||
| </members> | ||
| </doc> |
| <?xml version="1.0"?> | ||
| <doc> | ||
| <assembly> | ||
| <name>AtomFeed</name> | ||
| </assembly> | ||
| <members> | ||
| <member name="M:AtomFeed.Atom.Serialize(AtomFeed.Element.Feed,System.Text.Encoding)"> | ||
| <summary> | ||
| Serialize a feed to an XML document. | ||
| </summary> | ||
| <param name="feed">Feed object.</param> | ||
| <param name="encoding">XML declaration encoding.</param> | ||
| <returns></returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document string to feed instance. | ||
| </summary> | ||
| <param name="xml">XML string.</param> | ||
| <param name="strict">Strict mode. If the <c>strict</c> is <c>true</c>, the XML document syntax must be | ||
| fully compliant with the W3C validation, otherwise an exception will be thrown. If the | ||
| <c>strict</c> is <c>false</c>, those elements which are not compliant will be set to | ||
| <c>null</c> or <c>default</c>.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>xml</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.ReadOnlySpan{System.Byte},System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document buffer to feed instance. | ||
| </summary> | ||
| <param name="buffer">XML buffer.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>buffer</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <seealso cref="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Atom.Deserialize(System.IO.Stream,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an XML document stream to feed instance. | ||
| </summary> | ||
| <param name="stream">XML stream.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed instance. If the <c>strict</c> is <c>false</c> and the <c>stream</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <seealso cref="M:AtomFeed.Atom.Deserialize(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="F:AtomFeed.Constants.AtomNamespace"> | ||
| <summary> | ||
| Atom XML namespace. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Constants.AtomMimetype"> | ||
| <summary> | ||
| Atom MIME media type. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Category"> | ||
| <summary> | ||
| Specifies a category that the feed or entry belongs to. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Term"> | ||
| <summary> | ||
| Identifies the category. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Scheme"> | ||
| <summary> | ||
| Identifies the categorization scheme via a URI. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Category.Label"> | ||
| <summary> | ||
| Provides a human-readable label for display. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Content"> | ||
| <summary> | ||
| Content either contains, or links to, the complete content of the entry. | ||
| <para></para> | ||
| <para>In the most common case, the type attribute is either <c>text</c>, <c>html</c>, <c>xhtml</c>, | ||
| in which case the content element is defined identically to other text constructs.</para> | ||
| <para>If the <c>Src</c> attribute is present, it represents the URI of where the content | ||
| can be found. The <c>Type</c> attribute, if present, is the media type of the content.</para> | ||
| <para>Otherwise, if the <c>Type</c> attribute ends in <c>+xml</c> or <c>/xml</c>, then | ||
| an XML document of this type is contained in <c>Value</c>.</para> | ||
| <para>Otherwise, if the <c>Type</c> attribute starts with <c>text</c>, then an escaped document | ||
| of this type is contained in <c>Value</c>.</para> | ||
| <para>Otherwise, a base64 encoded document of the indicated media type is contained in <c>Value</c>.</para> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Entry"> | ||
| <summary> | ||
| An entry would be a single post on a weblog. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the entry using a universally unique and permanent URI. | ||
| Two entries in a feed can have the same value for id if they | ||
| represent the same entry at different points in time. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Contains a human-readable title for the entry. This value should not be blank. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the entry was modified. | ||
| This value need not change after a typo is fixed, only after a substantial modification. | ||
| Generally, different entries in a feed will have different updated timestamps. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Authors"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Names one author of the entry. An entry may have multiple authors. | ||
| An entry must contain at least one author unless there is an author | ||
| in the enclosing feed, or there is an author in the enclosed source. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Content"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Contains or links to the complete content of the entry. Content must be provided | ||
| if there is no alternate link, and should be provided if there is no summary. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Links"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Identifies related Web pages. The type of relation is defined by the rel attribute. | ||
| An entry is limited to one alternate per type and hreflang. An entry must contain an | ||
| alternate link if there is no content element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Summary"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Conveys a short summary, abstract, or excerpt of the entry. Summary should be provided | ||
| if there either is no content provided for the entry, or that content is not inline | ||
| (i.e., contains a src attribute), or if the content is encoded in base64. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Categories"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Specifies categories that the entry belongs to. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Contributors"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Names contributors to the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Published"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains the time of the initial creation or first availability of the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Rights"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Conveys information about rights, e.g. copyrights, held in and over the entry. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Entry.Source"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains metadata from the source feed if this entry is a copy. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Feed"> | ||
| <summary> | ||
| Atom feed root element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the feed using a universally unique and permanent URI. If you have a long-term, | ||
| renewable lease on your Internet domain name, then you can feel free to use your website's address. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| A human-readable title for the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the feed was modified. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Entries"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Entry list of the feed. An entry would be a single post on a weblog. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Authors"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Names one author of the feed. A feed may have multiple authors. | ||
| A feed must contain at least one author unless all the entries | ||
| contain at least one author element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Links"> | ||
| <summary> | ||
| <c>Recommended</c> | ||
| Identifies a related Web page. The type of relation is defined by the rel attribute. | ||
| A feed is limited to one alternate per type and hreflang. | ||
| A feed should contain a link back to the feed itself. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Categories"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Specifies a category that the feed belongs to. A feed may have multiple categories. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Contributors"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Names one contributor to the feed. A feed may have multiple contributors. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Generator"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies the software used to generate the feed, for debugging and other purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Icon"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies a small image which provides iconic visual identification for the feed. | ||
| Icons should be square. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Logo"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Identifies a larger image which provides visual identification for the feed. | ||
| Images should be twice as wide as they are tall. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Rights"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Conveys information about rights, e.g. copyrights, held in and over the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Feed.Subtitle"> | ||
| <summary> | ||
| <c>Optional</c> | ||
| Contains a human-readable description or subtitle for the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Generator"> | ||
| <summary> | ||
| Identifies the software used to generate the feed, for debugging and other purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Value"> | ||
| <summary> | ||
| Name of the software. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Uri"> | ||
| <summary> | ||
| The URI of the source (typically a Web page) used to generate the feed. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Generator.Version"> | ||
| <summary> | ||
| The version of the software. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Link"> | ||
| <summary> | ||
| Link is patterned after html's link element. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Href"> | ||
| <summary> | ||
| The URI of the referenced resource (typically a Web page). | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Relation"> | ||
| <summary> | ||
| A single link relationship type. | ||
| <para></para> | ||
| It can be a full URI, or one of the following predefined values (default=<c>alternate</c>): | ||
| <list type="bullet"> | ||
| <item><term><c>alternate</c>:</term> | ||
| <description>an alternate representation of the entry or feed, for example a permalink to the | ||
| html version of the entry, or the front page of the weblog.</description></item> | ||
| <item><term><c>enclosure</c>:</term> | ||
| <description>a related resource which is potentially large and might require special | ||
| handling, for example an audio or video recording.</description></item> | ||
| <item><term><c>related</c>:</term> | ||
| <description>a document related to the entry or feed.</description></item> | ||
| <item><term><c>self</c>:</term> | ||
| <description>the feed itself.</description></item> | ||
| <item><term><c>via</c>:</term> | ||
| <description>the source of the information provided in the entry.</description></item> | ||
| </list> | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Type"> | ||
| <summary> | ||
| Indicates the media type of the resource. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.HrefLanguage"> | ||
| <summary> | ||
| Indicates the language of the referenced resource. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Title"> | ||
| <summary> | ||
| Human-readable information about the link, typically for display purposes. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Link.Length"> | ||
| <summary> | ||
| The length of the resource, in bytes. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Author"> | ||
| <summary> | ||
| <inheritdoc cref="T:AtomFeed.Element.Person"/> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Contributor"> | ||
| <summary> | ||
| <inheritdoc cref="T:AtomFeed.Element.Person"/> | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Person"> | ||
| <summary> | ||
| <c>Author</c> and <c>Contributor</c> describe a person, corporation, or similar entity. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Name"> | ||
| <summary> | ||
| Conveys a human-readable name for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Email"> | ||
| <summary> | ||
| Contains an email address for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Person.Uri"> | ||
| <summary> | ||
| Contains a home page for the person. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Source"> | ||
| <summary> | ||
| Contains metadata from the source feed if the entry is a copy. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Id"> | ||
| <summary> | ||
| <c>Required</c> | ||
| Identifies the source using a universally unique and permanent URI. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Title"> | ||
| <summary> | ||
| <c>Required</c> | ||
| A human-readable title for the source. | ||
| </summary> | ||
| </member> | ||
| <member name="P:AtomFeed.Element.Source.Updated"> | ||
| <summary> | ||
| <c>Required</c> | ||
| The last time the source was modified. | ||
| </summary> | ||
| </member> | ||
| <member name="T:AtomFeed.Element.Text"> | ||
| <summary> | ||
| <c>title</c>, <c>subtitle</c>, <c>summary</c>, <c>content</c>, and | ||
| <c>rights</c> contain human-readable text, usually in small quantities. | ||
| The type attribute determines how this information is encoded (default="text"). | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Text"> | ||
| <summary> | ||
| Plain text with no entity escaped html. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Html"> | ||
| <summary> | ||
| Entity escaped html. | ||
| </summary> | ||
| </member> | ||
| <member name="F:AtomFeed.Element.TextType.Xhtml"> | ||
| <summary> | ||
| Inline xhtml, wrapped in a <c>div</c> element. | ||
| </summary> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML string. | ||
| </summary> | ||
| <param name="xml">XML string.</param> | ||
| <param name="strict">Strict mode. If the <c>strict</c> is <c>true</c>, the XML document syntax must be | ||
| fully compliant with the W3C validation, otherwise an exception will be thrown. If the | ||
| <c>strict</c> is <c>false</c>, those elements which are not compliant will be set to | ||
| <c>null</c> or <c>default</c>.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>xml</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.ReadOnlySpan{System.Byte},System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML buffer. | ||
| </summary> | ||
| <param name="buffer">XML buffer.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>buffer</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| <seealso cref="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.IO.Stream,System.Boolean)"> | ||
| <summary> | ||
| Deserialize feed from XML stream. | ||
| </summary> | ||
| <param name="stream">XML stream.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Feed object. If the <c>strict</c> is <c>false</c> and the <c>stream</c> is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.ArgumentException"></exception> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| <seealso cref="M:AtomFeed.Serialization.Serializer.DeserializeFeed(System.String,System.Boolean)"/> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeEntry(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean)"> | ||
| <summary> | ||
| Deserialize an entry node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Entry object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeText(System.Xml.XmlNode,System.Boolean)"> | ||
| <summary> | ||
| Deserialize text node in <c>title</c>, <c>summary</c>, <c>content</c>, and <c>rights</c> tags. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Text object.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeContent(System.Xml.XmlNode)"> | ||
| <summary> | ||
| Deserialize content node in <c>entry</c> element. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <returns>Content object.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializePerson(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize person node like <c>author</c> and <c>contributor</c>. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Person object. You may need to convert to <see cref="T:AtomFeed.Element.Author"/> or <see cref="T:AtomFeed.Element.Contributor"/>. | ||
| If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeLink(System.Xml.XmlNode,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize link node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Link object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeCategory(System.Xml.XmlNode,System.Boolean,System.String)"> | ||
| <summary> | ||
| Deserialize category node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <param name="parentNodeName">Parent node name.</param> | ||
| <returns>Category object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeGenerator(System.Xml.XmlNode,System.Boolean)"> | ||
| <summary> | ||
| Deserialize generator node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Generator object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.DeserializeSource(System.Xml.XmlNode,System.Xml.XmlNamespaceManager,System.Boolean)"> | ||
| <summary> | ||
| Deserialize source node. | ||
| </summary> | ||
| <param name="node">XML node.</param> | ||
| <param name="manager">Namespace manager.</param> | ||
| <param name="strict">Strict mode.</param> | ||
| <returns>Source object. If strict mode is disabled and the node is invalid, | ||
| then <c>null</c> is returned.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="F:AtomFeed.Serialization.Serializer.TextElementNames"> | ||
| <summary> | ||
| Available XML node names for <see cref="T:AtomFeed.Element.Text"/> object. | ||
| </summary> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeFeed(AtomFeed.Element.Feed,System.Text.Encoding)"> | ||
| <summary> | ||
| Serialize a feed object to an XML document. | ||
| </summary> | ||
| <param name="feed">Feed object.</param> | ||
| <param name="encoding">The value of the encoding attribute. | ||
| <seealso cref="M:System.Xml.XmlDocument.CreateXmlDeclaration(System.String,System.String,System.String)"/></param> | ||
| <returns>The XML document object.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeEntry(AtomFeed.Element.Entry,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize entry. | ||
| </summary> | ||
| <param name="entry">Entry object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>The XML element.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeAuthors(System.Collections.Generic.List{AtomFeed.Element.Author},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize authors. | ||
| </summary> | ||
| <param name="authors">Author list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>XML element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeLinks(System.Collections.Generic.List{AtomFeed.Element.Link},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize links. | ||
| </summary> | ||
| <param name="links">Link list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Link element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeCategories(System.Collections.Generic.List{AtomFeed.Element.Category},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize categories. | ||
| </summary> | ||
| <param name="categories">Category list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Category element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeContributors(System.Collections.Generic.List{AtomFeed.Element.Contributor},System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize contributors. | ||
| </summary> | ||
| <param name="contributors">Contributor list.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Contributor element list.</returns> | ||
| <exception cref="T:System.Data.ConstraintException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeGenerator(AtomFeed.Element.Generator,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize generator. | ||
| </summary> | ||
| <param name="generator">Generator object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Generator element.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeText(AtomFeed.Element.Text,System.String,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize text to given element name. | ||
| </summary> | ||
| <param name="text">Text object.</param> | ||
| <param name="name">Element name, <c>title</c>, <c>summary</c>, <c>content</c>, or <c>rights</c>.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>The XML element.</returns> | ||
| <exception cref="T:System.NotSupportedException"></exception> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeContent(AtomFeed.Element.Content,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize content of entry. | ||
| </summary> | ||
| <param name="content">Content object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Content element.</returns> | ||
| </member> | ||
| <member name="M:AtomFeed.Serialization.Serializer.SerializeSource(AtomFeed.Element.Source,System.Xml.XmlDocument)"> | ||
| <summary> | ||
| Serialize source. | ||
| </summary> | ||
| <param name="source">Source object.</param> | ||
| <param name="document">Root XML document.</param> | ||
| <returns>Source element.</returns> | ||
| </member> | ||
| </members> | ||
| </doc> |
Sorry, the diff of this file is not supported yet
@@ -6,2 +6,3 @@ <?xml version="1.0" encoding="utf-8"?> | ||
| <Default Extension="dll" ContentType="application/octet" /> | ||
| <Default Extension="xml" ContentType="application/octet" /> | ||
| <Default Extension="md" ContentType="application/octet" /> | ||
@@ -8,0 +9,0 @@ <Default Extension="nuspec" ContentType="application/octet" /> |
+2
-2
@@ -5,3 +5,3 @@ <?xml version="1.0" encoding="utf-8"?> | ||
| <id>AtomFeed</id> | ||
| <version>1.2.0</version> | ||
| <version>1.3.0</version> | ||
| <authors>chrishyze</authors> | ||
@@ -14,3 +14,3 @@ <license type="file">LICENSE</license> | ||
| <tags>Atom Feed RSS</tags> | ||
| <repository type="git" url="https://github.com/chrishyze/AtomFeed" commit="20d306f43d72f28e30059b92b2f115279ae1ed95" /> | ||
| <repository type="git" url="https://github.com/chrishyze/AtomFeed" commit="8288a5a38708a9dff9912e5f8b0ff12b1bc05ce6" /> | ||
| <dependencies> | ||
@@ -17,0 +17,0 @@ <group targetFramework="net8.0" /> |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
No alert changes
No metric changes