Akonadi::ContactGroupExpandJob Class Reference

#include <contactgroupexpandjob.h>

Inherits KJob.

Public Member Functions
	ContactGroupExpandJob (const KABC::ContactGroup &group, QObject *parent=0)
	ContactGroupExpandJob (const QString &name, QObject *parent=0)
	~ContactGroupExpandJob ()
KABC::Addressee::List	contacts () const
virtual void	start ()

Detailed Description

Job that expands a ContactGroup to a list of contacts.

This job takes a KABC::ContactGroup object or a name of a contact group and expands it to a list of KABC::Addressee objects by creating temporary KABC::Addressee objects for the KABC::ContactGroup::Data objects of the group and fetching the complete contacts from the Akonadi storage for the KABC::ContactGroup::ContactReferences of the group.

const KABC::ContactGroup group = ...;

Akonadi::ContactGroupExpandJob *job = new Akonadi::ContactGroupExpandJob( group );
connect( job, SIGNAL( result( KJob* ) ), this, SLOT( expandResult( KJob* ) ) );
job->start();

...

MyClass::expandResult( KJob *job )
{
  Akonadi::ContactGroupExpandJob *expandJob = qobject_cast<Akonadi::ContactGroupExpandJob*>( job );
  const KABC::Addressee::List contacts = expandJob->contacts();
  // do something with the contacts
}

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.4

Definition at line 64 of file contactgroupexpandjob.h.

Constructor & Destructor Documentation

ContactGroupExpandJob::ContactGroupExpandJob ( const KABC::ContactGroup &  group, QObject *  parent = 0  )

explicit

Creates a new contact group expand job.

Parameters

group	The contact group to expand.
parent	The parent object.

Definition at line 134 of file contactgroupexpandjob.cpp.

ContactGroupExpandJob::ContactGroupExpandJob ( const QString &  name, QObject *  parent = 0  )

explicit

Creates a new contact group expand job.

Parameters

name	The name of the contact group to expand.
parent	The parent object.

Since

4.5

Definition at line 139 of file contactgroupexpandjob.cpp.

ContactGroupExpandJob::~ContactGroupExpandJob

(

)

Destroys the contact group expand job.

Definition at line 144 of file contactgroupexpandjob.cpp.

Member Function Documentation

KABC::Addressee::List ContactGroupExpandJob::contacts

(

)

const

Returns the list of contacts.

Definition at line 162 of file contactgroupexpandjob.cpp.

void ContactGroupExpandJob::start ( )

virtual

Starts the expand job.

Definition at line 149 of file contactgroupexpandjob.cpp.

---

The documentation for this class was generated from the following files:

• contactgroupexpandjob.h
• contactgroupexpandjob.cpp