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

KBlog Client Library

KBlog::Blog

KBlog::Blog Class Reference

A class that provides methods to call functions on a supported blog web application. More...

#include <blog.h>

Inheritance diagram for KBlog::Blog:

Inheritance graph
[legend]

List of all members.


Public Types

enum  ErrorType {
  XmlRpc, Atom, ParsingError, AuthenticationError,
  NotSupported, Other
}

Signals

void createdPost (KBlog::BlogPost *post)
void error (KBlog::Blog::ErrorType type, const QString &errorMessage)
void errorComment (KBlog::Blog::ErrorType type, const QString &errorMessage, KBlog::BlogPost *post, KBlog::BlogComment *comment)
void errorMedia (KBlog::Blog::ErrorType type, const QString &errorMessage, KBlog::BlogMedia *media)
void errorPost (KBlog::Blog::ErrorType type, const QString &errorMessage, KBlog::BlogPost *post)
void fetchedPost (KBlog::BlogPost *post)
void listedRecentPosts (const QList< KBlog::BlogPost > &posts)
void modifiedPost (KBlog::BlogPost *post)
void removedPost (KBlog::BlogPost *post)

Public Member Functions

 Blog (const KUrl &server, QObject *parent=0, const QString &applicationName=QString(), const QString &applicationVersion=QString())
QString blogId () const
virtual void createPost (KBlog::BlogPost *post)=0
virtual void fetchPost (KBlog::BlogPost *post)=0
virtual QString interfaceName () const =0
virtual void listRecentPosts (int number)=0
virtual void modifyPost (KBlog::BlogPost *post)=0
QString password () const
virtual void removePost (KBlog::BlogPost *post)=0
virtual void setBlogId (const QString &blogId)
virtual void setPassword (const QString &password)
virtual void setTimeZone (const KTimeZone &timeZone)
virtual void setUrl (const KUrl &url)
virtual void setUsername (const QString &username)
KTimeZone timeZone ()
KUrl url () const
QString userAgent () const
QString username () const
virtual ~Blog ()

Protected Member Functions

 Blog (const KUrl &server, BlogPrivate &dd, QObject *parent=0, const QString &applicationName=QString(), const QString &applicationVersion=QString())

Protected Attributes

BlogPrivate *const d_ptr

Detailed Description

A class that provides methods to call functions on a supported blog web application.

This is the main interface to the blogging client library.

Author:
Christian Weilbach <christian_weilbach@web.de>

Mike Arthur <reinhold@kainhofer.com>

Reinhold Kainhofer <reinhold@kainhofer.com>

Definition at line 71 of file blog.h.


Member Enumeration Documentation

enum KBlog::Blog::ErrorType

Enumeration for possible errors.

Enumerator:
XmlRpc  An error in the XML-RPC client.

Atom  An error in the syndication client.

ParsingError  A parsing error.

AuthenticationError  An error on authentication.

NotSupported  An error where the method called is not supported by this object.

Other  Any other miscellaneous error.

Definition at line 97 of file blog.h.


Constructor & Destructor Documentation

Blog::Blog ( const KUrl &  server,
QObject *  parent = 0,
const QString &  applicationName = QString(),
const QString &  applicationVersion = QString() 
) [explicit]

Constructor used by the remote interface implementations.

Parameters:
server URL for the blog's remote interface.
parent the parent of this object, defaults to null.
applicationName the client application's name to use in the HTTP user agent string, defaults to KBlog's own.
applicationVersion the client application's version to use in the HTTP user agent string, defaults to KBlog's own.

Definition at line 34 of file blog.cpp.

Blog::~Blog (  )  [virtual]

Destroys the Blog object.

Definition at line 52 of file blog.cpp.

Blog::Blog ( const KUrl &  server,
BlogPrivate &  dd,
QObject *  parent = 0,
const QString &  applicationName = QString(),
const QString &  applicationVersion = QString() 
) [protected]

Constructor needed to allow private inheritance of 'Private' classes.

Parameters:
server URL for the blog's XML-RPC interface.
dd URL for the corresponding private class.
parent the parent of this object, defaults to null.
applicationName the client application's name to use in the HTTP user agent string, defaults to KBlog's own.
applicationVersion the client application's version to use in the HTTP user agent string, defaults to KBlog's own.

Definition at line 43 of file blog.cpp.


Member Function Documentation

QString Blog::blogId (  )  const

Returns the unique ID for the specific blog on the server.

See also:
setBlogId( const QString &blogId );

Definition at line 108 of file blog.cpp.

void KBlog::Blog::createdPost ( KBlog::BlogPost *  post  )  [signal]

This signal is emitted when a createPost() job creates a new blog post on the blogging server.

Parameters:
post the created post.
See also:
createPost()

virtual void KBlog::Blog::createPost ( KBlog::BlogPost *  post  )  [pure virtual]

Create a new blog post on the server.

Parameters:
post the blog post to create.
See also:
createdPost()

Implemented in KBlog::Blogger1, KBlog::GData, and KBlog::WordpressBuggy.

void KBlog::Blog::error ( KBlog::Blog::ErrorType  type,
const QString &  errorMessage 
) [signal]

This signal is emitted when an error occurs with XML parsing or a structural problem.

Parameters:
type the type of the error.
errorMessage the error message.
See also:
ErrorType

void KBlog::Blog::errorComment ( KBlog::Blog::ErrorType  type,
const QString &  errorMessage,
KBlog::BlogPost *  post,
KBlog::BlogComment *  comment 
) [signal]

This signal is emitted when an error occurs with XML parsing or a structural problem in an operation involving a blog post's comment.

Parameters:
type the type of the error.
errorMessage the error message.
post the post that caused the error.
comment the comment that caused the error.
See also:
ErrorType

void KBlog::Blog::errorMedia ( KBlog::Blog::ErrorType  type,
const QString &  errorMessage,
KBlog::BlogMedia *  media 
) [signal]

This signal is emitted when an error occurs with XML parsing or a structural problem in an operation involving some blog media.

Parameters:
type the type of the error.
errorMessage the error message.
media the media that caused the error.
See also:
ErrorType

void KBlog::Blog::errorPost ( KBlog::Blog::ErrorType  type,
const QString &  errorMessage,
KBlog::BlogPost *  post 
) [signal]

This signal is emitted when an error occurs with XML parsing or a structural problem in an operation involving a blog post.

Parameters:
type the type of the error.
errorMessage the error message.
post the post that caused the error.
See also:
ErrorType

void KBlog::Blog::fetchedPost ( KBlog::BlogPost *  post  )  [signal]

This signal is emitted when a fetchPost() job fetches a post from the blogging server.

Parameters:
post the fetched post.
See also:
fetchPost()

virtual void KBlog::Blog::fetchPost ( KBlog::BlogPost *  post  )  [pure virtual]

Fetch a blog post from the server with a specific ID.

The ID of the existing post must be retrieved using getRecentPosts and then be modified and provided to this method or a new BlogPost created with the existing ID.

Parameters:
post a blog post with the ID identifying the blog post to fetch.
See also:
fetchedPost()

listedRecentPosts( int number )

Implemented in KBlog::Blogger1, and KBlog::GData.

virtual QString KBlog::Blog::interfaceName (  )  const [pure virtual]

Returns the name of the blogging API this object implements.

Implemented in KBlog::Blogger1, KBlog::GData, KBlog::MetaWeblog, KBlog::MovableType, and KBlog::WordpressBuggy.

void KBlog::Blog::listedRecentPosts ( const QList< KBlog::BlogPost > &  posts  )  [signal]

This signal is emitted when a listRecentPosts() job fetches a post from the blogging server.

Parameters:
posts the list of posts.
See also:
listRecentPosts()

virtual void KBlog::Blog::listRecentPosts ( int  number  )  [pure virtual]

List a number of recent posts from the server.

The posts are returned in descending chronological order.

Parameters:
number the number of posts to fetch.
See also:
listedRecentPosts( const QList<KBlog::BlogPost>& posts )

Implemented in KBlog::Blogger1, KBlog::GData, and KBlog::MovableType.

void KBlog::Blog::modifiedPost ( KBlog::BlogPost *  post  )  [signal]

This signal is emitted when a modifyPost() job modifies a post on the blogging server.

Parameters:
post the modified post.
See also:
modifyPost()

virtual void KBlog::Blog::modifyPost ( KBlog::BlogPost *  post  )  [pure virtual]

Modify an existing blog post on the server.

The ID of the existing post must be retrieved using getRecentPosts and then be modified and provided to this method or a new BlogPost created with the existing ID.

Parameters:
post the new blog post.
See also:
modifiedPost()

listedRecentPosts( int number )

Implemented in KBlog::Blogger1, KBlog::GData, and KBlog::WordpressBuggy.

QString Blog::password (  )  const

Returns the password of the blog.

See also:
setPassword( const QString & );

Definition at line 84 of file blog.cpp.

void KBlog::Blog::removedPost ( KBlog::BlogPost *  post  )  [signal]

This signal is emitted when a removePost() job removes a post from the blogging server.

Parameters:
post the removed post.
See also:
removePost()

virtual void KBlog::Blog::removePost ( KBlog::BlogPost *  post  )  [pure virtual]

Remove an existing blog post from the server.

The BlogPost object representing the existing post must be retrieved using getRecentPosts and then provided to this method.

Parameters:
post* the blog post to remove.
See also:
removedPost()

listedRecentPosts( int number )

Implemented in KBlog::Blogger1, and KBlog::GData.

void Blog::setBlogId ( const QString &  blogId  )  [virtual]

Sets the unique ID for the specific blog on the server.

Parameters:
blogId the ID of the blog to send/receive from.
See also:
blogId();

Definition at line 102 of file blog.cpp.

void Blog::setPassword ( const QString &  password  )  [virtual]

Sets the password used in blog authentication.

Parameters:
password the blog's password.
See also:
password();

Definition at line 78 of file blog.cpp.

void Blog::setTimeZone ( const KTimeZone &  timeZone  )  [virtual]

Sets the time zone of the blog's server.

Parameters:
timeZone the time zone of the server.
See also:
timeZone()

Definition at line 126 of file blog.cpp.

void Blog::setUrl ( const KUrl &  url  )  [virtual]

Sets the URL for the blog's XML-RPC interface.

Parameters:
url the blog's XML-RPC URL.
See also:
url()

Reimplemented in KBlog::Blogger1.

Definition at line 114 of file blog.cpp.

void Blog::setUsername ( const QString &  username  )  [virtual]

Sets the username used in blog authentication.

Parameters:
username the blog's username.
See also:
username()

Definition at line 96 of file blog.cpp.

KTimeZone Blog::timeZone (  ) 

Get the time zone of the blog's server.

See also:
void setTimeZone()

Definition at line 132 of file blog.cpp.

KUrl Blog::url (  )  const

Get the URL for the blog's XML-RPC interface.

See also:
setUrl( const KUrl & )

Definition at line 120 of file blog.cpp.

QString Blog::userAgent (  )  const

Returns the HTTP user agent string used to make the HTTP requests.

Definition at line 58 of file blog.cpp.

QString Blog::username (  )  const

Returns the username used in blog authentication.

See also:
setUsername( const QString & )

Definition at line 90 of file blog.cpp.


Member Data Documentation

BlogPrivate* const KBlog::Blog::d_ptr [protected]

A pointer to the corresponding 'Private' class.

Definition at line 342 of file blog.h.


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

KBlog Client Library

Skip menu "KBlog Client Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

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