• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.4 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • FreeBusyProviderBase
Public Member Functions
Akonadi::FreeBusyProviderBase Class Reference

#include <freebusyproviderbase.h>

List of all members.

Public Member Functions

 FreeBusyProviderBase ()
 FreeBusyProviderBase ()
virtual ~FreeBusyProviderBase ()
virtual ~FreeBusyProviderBase ()
virtual void canHandleFreeBusy (const QString &email) const =0
virtual void canHandleFreeBusy (const QString &email) const =0
void freeBusyRetrieved (const QString &email, const QString &freeBusy, bool success, const QString &errorText=QString())
void freeBusyRetrieved (const QString &email, const QString &freeBusy, bool success, const QString &errorText=QString())
void handlesFreeBusy (const QString &email, bool handles) const
void handlesFreeBusy (const QString &email, bool handles) const
virtual KDateTime lastCacheUpdate () const =0
virtual KDateTime lastCacheUpdate () const =0
virtual void retrieveFreeBusy (const QString &email, const KDateTime &start, const KDateTime &end)=0
virtual void retrieveFreeBusy (const QString &email, const KDateTime &start, const KDateTime &end)=0

Detailed Description

Base class for resources providing free-busy information.

This class must be inherited by resources that are able to provide free-busy information for a given contact on request. A resource will thus inherit from ResourceBase and FreeBusyProvider.

Resources that provide FB info must declare it by adding 'FreeBusyProvider' in the X-Akonadi-Capabilities field of their .desktop file:

X-Akonadi-Capabilities=Resource,FreeBusyProvider

Resource inheriting from this class must implement lastCacheUpdate(), canHandleFreeBusy() and retrieveFreeBusy().

Since:
4.7

Definition at line 54 of file calendar/freebusyproviderbase.h.


Constructor & Destructor Documentation

FreeBusyProviderBase::FreeBusyProviderBase ( )

Creates a new FreeBusyProvider.

Definition at line 56 of file calendar/freebusyproviderbase.cpp.

FreeBusyProviderBase::~FreeBusyProviderBase ( )
virtual

Destroys a FreeBusyProvider.

Definition at line 61 of file calendar/freebusyproviderbase.cpp.

Akonadi::FreeBusyProviderBase::FreeBusyProviderBase ( )

Creates a new FreeBusyProvider.

virtual Akonadi::FreeBusyProviderBase::~FreeBusyProviderBase ( )
virtual

Destroys a FreeBusyProvider.


Member Function Documentation

virtual void Akonadi::FreeBusyProviderBase::canHandleFreeBusy ( const QString &  email) const
pure virtual

This method is called to find out is the resource handle free-busy information for the contact with email address email.

The caller will not wait for the result. Once the decision is known, the resource must call handlesFreeBusy().

Parameters:
emailThe email address of the contact we want the free-busy info. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
See also:
handlesFreeBusy()
virtual void Akonadi::FreeBusyProviderBase::canHandleFreeBusy ( const QString &  email) const
pure virtual

This method is called to find out is the resource handle free-busy information for the contact with email address email.

The caller will not wait for the result. Once the decision is known, the resource must call handlesFreeBusy().

Parameters:
emailThe email address of the contact we want the free-busy info. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
See also:
handlesFreeBusy()
void FreeBusyProviderBase::freeBusyRetrieved ( const QString &  email,
const QString &  freeBusy,
bool  success,
const QString &  errorText = QString() 
)

Derivate classes must call this method to notify the requestor that the result is here.

The freeBusy is expected to be an iTIP request containing the free-busy data. The simplest way to generate this is to use KCalCore::ICalFormat::createScheduleMessage() with the method KCalCore::iTIPRequest.

Parameters:
emailThe email address of the contact we give the response for. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
freeBusyThe free-busy data.
successWhether the retrieval was successful or not.
errorTextAn optional error message that can be displayed back to the user.

Definition at line 71 of file calendar/freebusyproviderbase.cpp.

void Akonadi::FreeBusyProviderBase::freeBusyRetrieved ( const QString &  email,
const QString &  freeBusy,
bool  success,
const QString &  errorText = QString() 
)

Derivate classes must call this method to notify the requestor that the result is here.

The freeBusy is expected to be an iTIP request containing the free-busy data. The simplest way to generate this is to use KCalCore::ICalFormat::createScheduleMessage() with the method KCalCore::iTIPRequest.

Parameters:
emailThe email address of the contact we give the response for. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
freeBusyThe free-busy data.
successWhether the retrieval was successful or not.
errorTextAn optional error message that can be displayed back to the user.
void Akonadi::FreeBusyProviderBase::handlesFreeBusy ( const QString &  email,
bool  handles 
) const

Derivate classes must call this method once they know if they handle free-busy information for the contact with email address email.

Parameters:
emailThe email address of the contact we give the response for. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
handlesWhether this resource handles free-busy (true) or not (false).
void FreeBusyProviderBase::handlesFreeBusy ( const QString &  email,
bool  handles 
) const

Derivate classes must call this method once they know if they handle free-busy information for the contact with email address email.

Parameters:
emailThe email address of the contact we give the response for. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
handlesWhether this resource handles free-busy (true) or not (false).

Definition at line 66 of file calendar/freebusyproviderbase.cpp.

virtual KDateTime Akonadi::FreeBusyProviderBase::lastCacheUpdate ( ) const
pure virtual

Returns the last time the free-busy information was fetched from the server.

This can be used for example to issue a warning to the user that this information may not be accurate and must be refreshed; pretty useful when the resource was offline for too long.

Returns:
The date and time the cache was last updated.
virtual KDateTime Akonadi::FreeBusyProviderBase::lastCacheUpdate ( ) const
pure virtual

Returns the last time the free-busy information was fetched from the server.

This can be used for example to issue a warning to the user that this information may not be accurate and must be refreshed; pretty useful when the resource was offline for too long.

Returns:
The date and time the cache was last updated.
virtual void Akonadi::FreeBusyProviderBase::retrieveFreeBusy ( const QString &  email,
const KDateTime &  start,
const KDateTime &  end 
)
pure virtual

This method is called when the resource must do the real work and fetch the free-busy information for the contact with email address email.

As with canHandleFreeBusy() the caller will not wait for the result and the resource must call freeBusyRetrieved() once done.

Parameters:
emailThe email address of the contact we want the free-busy info. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
startThe start of the period the free-busy request covers
endThe end of the free-busy period
See also:
freeBusyRetrieved()
virtual void Akonadi::FreeBusyProviderBase::retrieveFreeBusy ( const QString &  email,
const KDateTime &  start,
const KDateTime &  end 
)
pure virtual

This method is called when the resource must do the real work and fetch the free-busy information for the contact with email address email.

As with canHandleFreeBusy() the caller will not wait for the result and the resource must call freeBusyRetrieved() once done.

Parameters:
emailThe email address of the contact we want the free-busy info. This is a simple email address, in the form foo@b.nosp@m.ar.c.nosp@m.om (no display name or quoting).
startThe start of the period the free-busy request covers
endThe end of the free-busy period
See also:
freeBusyRetrieved()

The documentation for this class was generated from the following files:
  • calendar/freebusyproviderbase.h
  • kcal/freebusyproviderbase.h
  • calendar/freebusyproviderbase.cpp
  • kcal/freebusyproviderbase.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Mon Jun 24 2013 13:00:51 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.10.4 API Reference

Skip menu "kdepimlibs-4.10.4 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal