Akonadi::AgentType Class Reference

#include <agenttype.h>

Public Types
using	List = QList<AgentType>

Public Member Functions
	AgentType ()
	AgentType (const 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
AgentType &	operator= (const AgentType &other)
bool	operator== (const AgentType &other) const

Detailed Description

A representation of an agent type.

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.nosp@m.@kde.nosp@m..org

Definition at line 43 of file core/agenttype.h.

Member Typedef Documentation

List

using Akonadi::AgentType::List = QList<AgentType>

Describes a list of agent types.

Definition at line 52 of file core/agenttype.h.

Constructor & Destructor Documentation

AgentType() [1/2]

Akonadi::AgentType::AgentType

(

)

Creates a new agent type.

AgentType() [2/2]

AgentType::AgentType

(

const AgentType &

other

)

Creates an agent type from an other agent type.

Definition at line 19 of file core/agenttype.cpp.

~AgentType()

AgentType::~AgentType

(

)

Destroys the agent type.

Definition at line 24 of file core/agenttype.cpp.

Member Function Documentation

capabilities()

QStringList Akonadi::AgentType::capabilities ( ) const

nodiscard

Returns the list of supported capabilities of the agent type.

customProperties()

QVariantMap AgentType::customProperties ( ) const

nodiscard

Returns a Map of custom properties of the agent type.

Since

4.12

Definition at line 68 of file core/agenttype.cpp.

description()

QString AgentType::description ( ) const

nodiscard

Returns the description of the agent type.

Definition at line 43 of file core/agenttype.cpp.

icon()

QIcon Akonadi::AgentType::icon ( ) const

nodiscard

Returns the icon of the agent type.

iconName()

QString AgentType::iconName ( ) const

nodiscard

Returns the name of the icon of the agent type.

Definition at line 48 of file core/agenttype.cpp.

identifier()

QString Akonadi::AgentType::identifier ( ) const

nodiscard

Returns the unique identifier of the agent type.

isValid()

bool AgentType::isValid ( ) const

nodiscard

Returns whether the agent type is valid.

Definition at line 28 of file core/agenttype.cpp.

mimeTypes()

QStringList Akonadi::AgentType::mimeTypes ( ) const

nodiscard

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

name()

QString Akonadi::AgentType::name ( ) const

nodiscard

Returns the i18n'ed name of the agent type.

operator=()

AgentType & AgentType::operator=

(

const AgentType &

other

)

Parameters

other

other agent type

Definition at line 73 of file core/agenttype.cpp.

operator==()

bool AgentType::operator==

(

const AgentType &

other

)

const

Parameters

other

other agent type

Definition at line 82 of file core/agenttype.cpp.

---

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

• core/agenttype.h
• core/agenttype.cpp