Akonadi::AgentType Class

class Akonadi::AgentType

A representation of an agent type. More...

Header:	`#include <Akonadi/AgentType>`
CMake:	`find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)` `target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)`

List of all members, including inherited members

Public Functions

	AgentType()
	AgentType(const Akonadi::AgentType &other)
	~AgentType()
QStringList	capabilities() const
QVariantMap	customProperties() const
QString	description() const
QIcon	icon() const
QString	iconName() const
QString	identifier() const
bool	isValid() const
QStringList	mimeTypes() const
QString	name() const

Detailed Description

The agent type is a representation of an available agent, that can be started as an agent instance. It provides all information about the type.

All available agent types can be retrieved from the AgentManager.

 Akonadi::AgentType::List types = Akonadi::AgentManager::self()->types();
 for ( const Akonadi::AgentType &type : types ) {
   qDebug() << "Name:" << type.name() << "(" << type.identifier() << ")";
 }

Author: Tobias Koenig <tokoe@kde.org>

Member Function Documentation

AgentType::AgentType()

Creates a new agent type.

AgentType::AgentType(const Akonadi::AgentType &other)

Creates an agent type from an other agent type.

`[noexcept]` AgentType::~AgentType()

Destroys the agent type.

QStringList AgentType::capabilities() const

Returns the list of supported capabilities of the agent type.

QVariantMap AgentType::customProperties() const

Returns a Map of custom properties of the agent type.

QString AgentType::description() const

Returns the description of the agent type.

QIcon AgentType::icon() const

Returns the icon of the agent type.

QString AgentType::iconName() const

Returns the name of the icon of the agent type.

QString AgentType::identifier() const

Returns the unique identifier of the agent type.

bool AgentType::isValid() const

Returns whether the agent type is valid.

QStringList AgentType::mimeTypes() const

Returns the list of supported mime types of the agent type.

QString AgentType::name() const

Returns the i18n'ed name of the agent type.

Contents