• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

syndication/rdf

Syndication::RDF::SyndicationInfo

Syndication::RDF::SyndicationInfo Class Reference

Wrapper to access syndication information for a feed. More...

#include <syndicationinfo.h>

Inheritance diagram for Syndication::RDF::SyndicationInfo:

Inheritance graph
[legend]

List of all members.


Public Types

enum  Period {
  Hourly, Daily, Weekly, Monthly,
  Yearly
}

Public Member Functions

QString debugInfo () const
 SyndicationInfo (ResourcePtr resource)
 SyndicationInfo ()
time_t updateBase () const
int updateFrequency () const
Period updatePeriod () const
virtual ~SyndicationInfo ()

Static Protected Member Functions

static QString periodToString (Period period)
static Period stringToPeriod (const QString &str)

Detailed Description

Wrapper to access syndication information for a feed.

The RSS 1.0 syndication module provides syndication hints to aggregators regarding how often it is updated.

The specification can be found at http://web.resource.org/rss/1.0/modules/syndication/

Author:
Frank Osterfeld

Definition at line 44 of file syndicationinfo.h.


Member Enumeration Documentation

enum Syndication::RDF::SyndicationInfo::Period

update period enum as used by updatePeriod().

Enumerator:
Hourly  the feed is updated hourly
Daily  the feed is updated daily
Weekly  the feed is updated weekly
Monthly  the feed is updated monthly
Yearly  the feed is updated yearly

Definition at line 51 of file syndicationinfo.h.


Constructor & Destructor Documentation

Syndication::RDF::SyndicationInfo::SyndicationInfo (  ) 

creates a wrapper wrapping a null resource.

isNull() will be true.

Syndication::RDF::SyndicationInfo::SyndicationInfo ( ResourcePtr  resource  )  [explicit]

creates a wrapper from a resource

Parameters:
resource the feed resource to read syndication information from

Definition at line 35 of file syndicationinfo.cpp.

Syndication::RDF::SyndicationInfo::~SyndicationInfo (  )  [virtual]

virtual destructor

Definition at line 39 of file syndicationinfo.cpp.


Member Function Documentation

QString Syndication::RDF::SyndicationInfo::debugInfo (  )  const

description of the syndication information for debugging purposes

Returns:
debug string

Definition at line 71 of file syndicationinfo.cpp.

QString Syndication::RDF::SyndicationInfo::periodToString ( Period  period  )  [static, protected]

returns Period value as string.

Parameters:
period period enum to convert to a string
Returns:
the enum name in lower case, "daily", "hourly", etc.

Definition at line 85 of file syndicationinfo.cpp.

SyndicationInfo::Period Syndication::RDF::SyndicationInfo::stringToPeriod ( const QString &  str  )  [static, protected]

parses a Period value from a string.

Parameters:
str a period string as defined in the syndication module
Returns:
the parsed period, Daily (the default) if the parsed string is empty or invalid

Definition at line 104 of file syndicationinfo.cpp.

time_t Syndication::RDF::SyndicationInfo::updateBase (  )  const

Defines a base date to be used in concert with updatePeriod and updateFrequency to calculate the publishing schedule.

Returns:
the base date in seconds since epoch. Default value is 0 (epoch).

Definition at line 64 of file syndicationinfo.cpp.

int Syndication::RDF::SyndicationInfo::updateFrequency (  )  const

Used to describe the frequency of updates in relation to the update period.

A positive integer indicates how many times in that period the channel is updated. For example, an updatePeriod of daily, and an updateFrequency of 2 indicates the channel format is updated twice daily. If omitted a value of 1 is assumed.

Returns:
update frequency, default is 1

Definition at line 48 of file syndicationinfo.cpp.

SyndicationInfo::Period Syndication::RDF::SyndicationInfo::updatePeriod (  )  const

Describes the period over which the channel format is updated.

Acceptable values are: hourly, daily, weekly, monthly, yearly. If omitted, daily is assumed.

Returns:
update period, daily is default

Definition at line 43 of file syndicationinfo.cpp.


The documentation for this class was generated from the following files:
  • syndicationinfo.h
  • syndicationinfo.cpp

syndication/rdf

Skip menu "syndication/rdf"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal