Syndication::ItemRSS2Impl
#include <itemrss2impl.h>
Public Member Functions | |
ItemRSS2Impl (const Syndication::RSS2::Item &item) | |
QMultiMap< QString, QDomElement > | additionalProperties () const override |
QList< PersonPtr > | authors () const override |
QList< CategoryPtr > | categories () const override |
QString | commentPostUri () const override |
int | commentsCount () const override |
QString | commentsFeed () const override |
QString | commentsLink () const override |
QString | content () const override |
time_t | datePublished () const override |
time_t | dateUpdated () const override |
QString | description () const override |
QList< EnclosurePtr > | enclosures () const override |
QString | id () const override |
QString | language () const override |
QString | link () const override |
SpecificItemPtr | specificItem () const override |
QString | title () const override |
Public Member Functions inherited from Syndication::Item | |
virtual | ~Item () |
virtual QString | debugInfo () const |
Detailed Description
Definition at line 22 of file itemrss2impl.h.
Constructor & Destructor Documentation
◆ ItemRSS2Impl()
|
explicit |
Definition at line 24 of file itemrss2impl.cpp.
Member Function Documentation
◆ additionalProperties()
|
overridevirtual |
returns a list of item metadata not covered by this class.
Can be used e.g. to access format extensions.
The returned map contains key value pairs, where the key is the tag name of the element, namespace prefix are resolved to the corresponding URIs. The value is the XML element as read from the document.
For example, to access the <itunes:keywords> element, use additionalProperties()["http://www.itunes.com/dtds/podcast-1.0.dtdkeywords"].
Currently this is only supported for RSS 0.91..0.94/2.0 and Atom formats, but not for RDF (RSS 0.9 and 1.0).
Implements Syndication::Item.
Definition at line 163 of file itemrss2impl.cpp.
◆ authors()
|
overridevirtual |
returns a list of persons who created the item content.
If there is a distinction between authors and contributors (Atom), both are added to the list, where authors are added first.
- Returns
- list of authors (and possibly other contributing persons)
Implements Syndication::Item.
Definition at line 59 of file itemrss2impl.cpp.
◆ categories()
|
overridevirtual |
returns a list of categories this item is filed in.
See Category for more information on categories.
- Returns
- a list of categories
Implements Syndication::Item.
Definition at line 117 of file itemrss2impl.cpp.
◆ commentPostUri()
|
overridevirtual |
URI that can be used to post comments via an HTTP POST request using the Comment API.
For more details on the Comment API, see http://wellformedweb.org/story/9
- Returns
- URI for posting comments, or a null string if not set
Implements Syndication::Item.
Definition at line 153 of file itemrss2impl.cpp.
◆ commentsCount()
|
overridevirtual |
The number of comments posted for this item.
- Returns
- the number of comments associated to this item, or -1 if not specified
Implements Syndication::Item.
Definition at line 131 of file itemrss2impl.cpp.
◆ commentsFeed()
|
overridevirtual |
URL of feed syndicating comments belonging to this item.
- Returns
- comments feed URL, or a null string if not set
Implements Syndication::Item.
Definition at line 144 of file itemrss2impl.cpp.
◆ commentsLink()
|
overridevirtual |
Link to an HTML site which contains the comments belonging to this item.
- Returns
- URL to the comments page, or a null string if not set
Implements Syndication::Item.
Definition at line 139 of file itemrss2impl.cpp.
◆ content()
|
overridevirtual |
returns the content of the item.
If provided, this is the most comprehensive text content available for this item. If it is empty, use description() (which might also contain complete article content).
This string may contain HTML markup. (Importantly, occurrences of the characters <,'
', '&', '\'' and '"' are escaped).
- Returns
- content string as HTML, or a null string if not set
Implements Syndication::Item.
Definition at line 54 of file itemrss2impl.cpp.
◆ datePublished()
|
overridevirtual |
returns the date when the item was initially published.
- Returns
- publication date, as seconds since epoch (Jan 1st 1970), or 0 (epoch) if not set
Implements Syndication::Item.
Definition at line 87 of file itemrss2impl.cpp.
◆ dateUpdated()
|
overridevirtual |
returns the date when the item was modified the last time.
If no such date is provided by the feed, this method returns the value of datePublished().
- Returns
- modification date, as seconds since epoch (Jan 1st 1970)
Implements Syndication::Item.
Definition at line 92 of file itemrss2impl.cpp.
◆ description()
|
overridevirtual |
returns the description of the item.
The description can either be a tag line, a short summary of the item content up to a complete article. If content() is non-empty, it
This string may contain HTML markup. (Importantly, occurrences of the characters <,'
', '&', '\'' and '"' are escaped).
- Returns
- the description as HTML, or a null string if not specified
Implements Syndication::Item.
Definition at line 49 of file itemrss2impl.cpp.
◆ enclosures()
|
overridevirtual |
returns a list of enclosures describing files available on the net.
(often used for audio files, so-called "Podcasts").
- Returns
- a list of enclosures associated with this item
Implements Syndication::Item.
Definition at line 103 of file itemrss2impl.cpp.
◆ id()
|
overridevirtual |
returns an identifier that identifies the item within its feed.
The ID must be unique within its feed. If no ID is provided by the feed source, a hash from title, description and content is returned. Generated hash IDs start with "hash:".
Implements Syndication::Item.
Definition at line 77 of file itemrss2impl.cpp.
◆ language()
|
overridevirtual |
returns the language used in the item's content
- Returns
- TODO: tell about language codes and link them
Implements Syndication::Item.
Definition at line 72 of file itemrss2impl.cpp.
◆ link()
|
overridevirtual |
returns a link to the (web) resource described by this item.
In most cases, this will be a website containing the full article associated with this item.
- Returns
- a URL, or a null string if not specified
Implements Syndication::Item.
Definition at line 34 of file itemrss2impl.cpp.
◆ specificItem()
|
overridevirtual |
returns the format-specific item this object abstracts from.
Use it if you need to access format-specifics that are not covered by this abstraction.
Implements Syndication::Item.
Definition at line 158 of file itemrss2impl.cpp.
◆ title()
|
overridevirtual |
The title of the item.
This string may contain HTML markup.(Importantly, occurrences of the characters <,'
', '&', '\'' and '"' are escaped).
- Returns
- the title of the item as HTML, or a null string if not specified
Implements Syndication::Item.
Definition at line 29 of file itemrss2impl.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:18 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.