• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/kopete

Public Slots | Signals | Public Member Functions | List of all members
KopeteDBusInterface Class Reference

#include <kopetedbusinterface.h>

Inheritance diagram for KopeteDBusInterface:
Inheritance graph
[legend]

Public Slots

QStringList accounts () const
 
bool addContact (const QString &protocolName, const QString &accountId, const QString &contactId, const QString &displayName, const QString &groupName=QString())
 
void connect (const QString &protocolName, const QString &accountId)
 
void connectAll ()
 
QVariantMap contactProperties (const QString &contactId)
 
QStringList contacts () const
 
QStringList contactsByFilter (const QString &filter) const
 
void disconnect (const QString &protocolName, const QString &accountId)
 
void disconnectAll ()
 
QString getDisplayName (const QString &contactId)
 
QStringList identities () const
 
bool isConnected (const QString &protocolName, const QString &accountId)
 
bool isContactOnline (const QString &contactId)
 
QString labelForIdentity (const QString &id) const
 
void openChat (const QString &contactId)
 
QStringList protocols () const
 
void resume ()
 
void sendFile (const QString &contactId, const QString &fileUrl)
 
void sendMessage (const QString &contactId, const QString &message)
 
void setIdentityAvatar (const QString &avatarUrl, const QString &identityId=QString())
 
void setIdentityNickName (const QString &nickName, const QString &identityId=QString())
 
void setIdentityOnlineStatus (const QString &status, const QString &message, const QString &identityId=QString())
 
void setOnlineStatus (const QString &status, const QString &message=QString())
 
void setStatusMessage (const QString &message)
 
void suspend ()
 

Signals

void contactChanged (QString contactId)
 

Public Member Functions

 KopeteDBusInterface (QObject *parent)
 
 ~KopeteDBusInterface ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObject * child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArray > dynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
T findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObject * metaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObject * parent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThread * thread () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObject * sender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Public D-Bus interface for Kopete.

Author
Michaƫl Larouche larou.nosp@m.che@.nosp@m.kde.o.nosp@m.rg

Definition at line 30 of file kopetedbusinterface.h.

Constructor & Destructor Documentation

KopeteDBusInterface::KopeteDBusInterface ( QObject *  parent)

Constructor.

Parameters
parentQObject parent

Definition at line 51 of file kopetedbusinterface.cpp.

KopeteDBusInterface::~KopeteDBusInterface ( )

Destructor.

Definition at line 61 of file kopetedbusinterface.cpp.

Member Function Documentation

QStringList KopeteDBusInterface::accounts ( ) const
slot

Get a list of all account's ID.

Returns
a list of all accounts' ID

Definition at line 234 of file kopetedbusinterface.cpp.

bool KopeteDBusInterface::addContact ( const QString &  protocolName,
const QString &  accountId,
const QString &  contactId,
const QString &  displayName,
const QString &  groupName = QString() 
)
slot

Adds a contact with the specified params.

Parameters
protocolNameThe name of the protocol this contact is for ("Jabber", etc)
accountIdThe account ID to add the contact to
contactIdThe unique ID for this protocol
displayNameThe displayName of the contact (may equal userId for some protocols
groupNameThe name of the group to add the contact to
Returns
Weather or not the contact was added successfully

Definition at line 333 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::connect ( const QString &  protocolName,
const QString &  accountId 
)
slot

Connect a given account in the given protocol.

Parameters
protocolNameThe protocol name (ex: Jabber, Yahoo, Messenger)
accountIdAccount ID

Definition at line 401 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::connectAll ( )
slot

Connect all accounts.

Definition at line 246 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::contactChanged ( QString  contactId)
signal

Contact properties have changed: displayName, avatar, pending messages...

Parameters
contactIdID of the contact whose properties have changed
QVariantMap KopeteDBusInterface::contactProperties ( const QString &  contactId)
slot

Look up details for a specific contact.

Parameters
contactIdContact ID or display Name
Returns
A QVariantMap containing contact properties like online status, avatar, ...
Todo:
: export status message title as well or merge both?

Definition at line 435 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::contacts ( ) const
slot

Return all contacts.

Returns
a list of all contacts display name

Definition at line 75 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::contactsByFilter ( const QString &  filter) const
slot

Get a filered list of contacts based on the filter.

Accetable filters are: online, reachable, filecapable. If no accepted filters are provived, it will return an empty list.

Returns
list of filtered contacts

Definition at line 80 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::disconnect ( const QString &  protocolName,
const QString &  accountId 
)
slot

Disconnect a given account in the given protocol.

Parameters
protocolNameThe protocol name (ex: Jabber, Yahoo, Messenger)
accountIdAccount ID

Definition at line 418 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::disconnectAll ( )
slot

Disconnect all accounts.

Definition at line 253 of file kopetedbusinterface.cpp.

QString KopeteDBusInterface::getDisplayName ( const QString &  contactId)
slot

Retrieve the Display Name from the given contact ID.

Parameters
contactIdMetacontact contactId

Definition at line 315 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::identities ( ) const
slot

Get a list of all identities' ID.

Returns
a list of all identities' ID

Definition at line 208 of file kopetedbusinterface.cpp.

bool KopeteDBusInterface::isConnected ( const QString &  protocolName,
const QString &  accountId 
)
slot

Get information if we are connected to a given account in the given protocol.

Parameters
protocolNameThe protocol name (ex: Jabber, Yahoo, Messenger)
accountIdAccount ID
Returns
if the given protocolName and accountId are valid and we are connected then true is returned else false is returned.

Definition at line 387 of file kopetedbusinterface.cpp.

bool KopeteDBusInterface::isContactOnline ( const QString &  contactId)
slot

Get the Online Status of the contact.

Parameters
contactIdMetacontact ID or displayName

Definition at line 324 of file kopetedbusinterface.cpp.

QString KopeteDBusInterface::labelForIdentity ( const QString &  id) const
slot

Get UI labels for identities.

Returns
a label for a identity.

Definition at line 220 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::openChat ( const QString &  contactId)
slot

Open a chat window for the given contact.

Parameters
contactIdMetacontact ID or displayName

Definition at line 301 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::protocols ( ) const
slot

Get a list of all protocol names.

Returns
a list of all protocol names.

Definition at line 65 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::resume ( )
slot

Sets the online status of all accounts to the status they had when suspend was called.

Definition at line 264 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::sendFile ( const QString &  contactId,
const QString &  fileUrl 
)
slot

Send a file to the given contact.

Parameters
contactIdMetacontact ID or displayName to send a file to
fileUrlUrl of the file to send

Definition at line 373 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::sendMessage ( const QString &  contactId,
const QString &  message 
)
slot

Send a message to the given contact.

Parameters
contactIdMetacontact ID or displayName to send a message to
messageThe message to send

Definition at line 281 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityAvatar ( const QString &  avatarUrl,
const QString &  identityId = QString() 
)
slot

Set the avatar for the given identity.

To set the avatar of the default identity, use an empty identityId

Parameters
avatarUrlPath to the avatar image
identityIdIdentity ID to modify. If empty, will use default identity

Definition at line 159 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityNickName ( const QString &  nickName,
const QString &  identityId = QString() 
)
slot

Set the nickname for the given identity.

To set the nickname of the default identity, use an empty identityId

Parameters
nickNameNew nickname of the identity
identityIdIdentity ID to modify. If empty, will use default identity.

Definition at line 138 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityOnlineStatus ( const QString &  status,
const QString &  message,
const QString &  identityId = QString() 
)
slot

Set the online status for the given identity.

To set the online status of the default identity, use an empty identityId

Parameters
statusThe english word for the status you want.
messageStatus message, can be an empty string
identityIdIdentity ID to modify. If empty, will use default identity

Definition at line 188 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setOnlineStatus ( const QString &  status,
const QString &  message = QString() 
)
slot

Change the online status for all accounts.

Accepted values for status are: Online, Busy, Away, Available

Parameters
statusThe english word for the status you want.
messageOptional status message

Definition at line 269 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setStatusMessage ( const QString &  message)
slot

Change the status message for all accounts.

Use an empty string to clear the status message

Parameters
messageStatus message

Definition at line 276 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::suspend ( )
slot

Saves the online status of all accounts and disconnects them.

Definition at line 259 of file kopetedbusinterface.cpp.


The documentation for this class was generated from the following files:
  • kopetedbusinterface.h
  • kopetedbusinterface.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:08 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/kopete

Skip menu "kopete/kopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



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