KPeople Namespace

Header: #include <KPeople>
CMake: find_package(KF6 REQUIRED COMPONENTS People)
target_link_libraries(mytarget PRIVATE KF6::People)

Classes

(since 5.8) class AbstractContact
class AbstractPersonAction
(since 5.8) class AllContactsMonitor
class BasePersonsDataSource
class BasePersonsDataSourceV2
(since 5.8) class ContactMonitor
(since 5.8) class MergeDialog
(since 5.8) class PersonData
(since 5.8) class PersonDetailsView
(since 5.51) class PersonPluginManager
(since 5.8) class PersonsModel
(since 5.12) class PersonsSortFilterProxyModel

Types

enum ActionType { TextChatAction, AudioCallAction, VideoCallAction, SendEmailAction, SendFileAction, OtherAction }

Functions

QList<QAction *> actionsForPerson(const QString &contactUri, QObject *parent)
QString iconNameForPresenceString(const QString &presenceName)
QString mergeContacts(const QStringList &uris)
int presenceSortPriority(const QString &presenceName)
bool unmergeContact(const QString &uri)

Detailed Description

Classes

class PersonData

Allows querying the information about a given person. More...

class PersonPluginManager

This class allows applications to manage DataSource plugins. More...

class PersonsModel

This class creates a model of all known contacts from all sources. More...

class PersonsSortFilterProxyModel

Helps filtering and sorting PersonsModel. More...

Type Documentation

enum KPeople::ActionType

Each action returned in the list can be one of these types, however the Type is not mandatory with the action

The type should be set as QObject property "actionType"

ConstantValue
KPeople::TextChatAction0
KPeople::AudioCallAction1
KPeople::VideoCallAction2
KPeople::SendEmailAction3
KPeople::SendFileAction4
KPeople::OtherAction100

Function Documentation

QList<QAction *> KPeople::actionsForPerson(const QString &contactUri, QObject *parent)

Returns a list of actions relevant to the specified contactUri where each QAction will have parent passed as its parent QObject

QString KPeople::iconNameForPresenceString(const QString &presenceName)

Return a QPixmap for a TP presence string

QString KPeople::mergeContacts(const QStringList &uris)

Merge all uris into a single person.

Ids can be a mix of person Ids and contact IDs.

uris a list of all identifiers to be merged

Returns the identifier of the new person or an empty string upon failure

int KPeople::presenceSortPriority(const QString &presenceName)

Returns a sort priority for the given presenceName

bool KPeople::unmergeContact(const QString &uri)

Unmerge a contact. Either remove a contact from a given person or remove a person identified by @p uri.

Returns whether the unmerge was successful