Syndication::Person

Syndication::Person Class Referenceabstract

#include <person.h>

Public Member Functions

virtual ~Person ()
 
virtual QString debugInfo () const
 
virtual QString email () const =0
 
virtual bool isNull () const =0
 
virtual QString name () const =0
 
virtual bool operator== (const Person &other) const
 
virtual QString uri () const =0
 

Detailed Description

Person objects hold information about a person, such as the author of the content syndicated in the feed.

Depending on the feed format, different information is available. While according to the RSS2 spec, RSS2 author elements must contain only an e-mail address, Atom requires the person's name and the e-mail address is optional. Also, in reality, feeds often contain other information than what is specified in the specs. Syndication tries to find out what author information is contained and maps it to this representation.

Author
Frank Osterfeld

Definition at line 52 of file person.h.

Constructor & Destructor Documentation

Syndication::Person::~Person ( )
virtual

destructor

Definition at line 30 of file person.cpp.

Member Function Documentation

QString Syndication::Person::debugInfo ( ) const
virtual

description of the person for debugging purposes.

Returns
debug string

Definition at line 34 of file person.cpp.

virtual QString Syndication::Person::email ( ) const
pure virtual

e-mail address of the person (optional)

Returns
email address, or a null string if not specified
virtual bool Syndication::Person::isNull ( ) const
pure virtual

returns whether this object is a null person

virtual QString Syndication::Person::name ( ) const
pure virtual

the name of the person (optional)

Returns
the name of the person as plain text, or a null string if not specified
bool Syndication::Person::operator== ( const Person other) const
virtual

compares two person instances.

Persons are equal if and only if their respective name(), uri() and email() values are equal.

Parameters
otheranother person instance

Definition at line 61 of file person.cpp.

virtual QString Syndication::Person::uri ( ) const
pure virtual

a URI associated with the person.

(optional) This is usually the URL of the person's homepage.

Returns
URI of the person, or a null string if not specified

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Jul 9 2020 23:01:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.