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

kopete/kopete

  • sources
  • kde-4.12
  • kdenetwork
  • kopete
  • kopete
kimiface.h
Go to the documentation of this file.
1 /*
2  kimiface.h - KDE Instant Messenger DCOP Interface
3 
4  Copyright (c) 2004 Will Stephenson <wstephenson@kde.org>
5 
6  This library is free software; you can redistribute it and/or
7  modify it under the terms of the GNU Library General Public
8  License as published by the Free Software Foundation; either
9  version 2 of the License, or (at your option) any later version.
10 
11  This library is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  Library General Public License for more details.
15 
16  You should have received a copy of the GNU Library General Public License
17  along with this library; see the file COPYING.LIB. If not, write to
18  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  Boston, MA 02110-1301, USA.
20 */
21 
22 #ifndef KIMIFACE_H
23 #define KIMIFACE_H
24 
25 #include <qpixmap.h>
26 #include <QByteArray>
27 #include <dcopobject.h>
28 #include <qstringlist.h>
29 #include <kurl.h>
30 
36 class KIMIface : virtual public DCOPObject
37 {
38  K_DCOP
39 
40 k_dcop:
41 // ACCESSORS
42 // contact list
48  virtual QStringList allContacts() = 0;
54  virtual QStringList reachableContacts() = 0;
60  virtual QStringList onlineContacts() = 0;
66  virtual QStringList fileTransferContacts() = 0;
67 
68 // individual
74  virtual bool isPresent( const QString & uid ) = 0;
81  virtual QString displayName( const QString & uid ) = 0;
87  virtual QString presenceString( const QString & uid ) = 0;
93  virtual int presenceStatus( const QString & uid ) = 0;
99  virtual bool canReceiveFiles( const QString & uid ) = 0;
105  virtual bool canRespond( const QString & uid ) = 0;
113  virtual QString locate( const QString & contactId, const QString & protocol ) = 0;
114 // metadata
120  virtual QPixmap icon( const QString & uid ) = 0;
126  virtual QString context( const QString & uid ) = 0;
127 // App capabilities
132  virtual QStringList protocols() = 0;
133 
134 // ACTORS
142  virtual void messageContact( const QString &uid, const QString& message ) = 0;
143 
147  virtual void messageNewContact( const QString &contactId, const QString &protocol ) = 0;
148 
153  virtual void chatWithContact( const QString &uid ) = 0;
154 
162  virtual void sendFile(const QString &uid, const KUrl &sourceURL,
163  const QString &altFileName = QString(), uint fileSize = 0) = 0;
164 
165 // MUTATORS
166 // Contact list
173  virtual bool addContact( const QString &contactId, const QString &protocol ) = 0;
174 // SIGNALS
175 k_dcop_signals:
182  void contactPresenceChanged( QString uid, QByteArray appId, int presence );
183 };
184 
185 #endif
186 
187 
188 
189 /*
190  * Local variables:
191  * c-indentation-style: k&r
192  * c-basic-offset: 8
193  * indent-tabs-mode: t
194  * End:
195  */
196 // vim: set noet ts=4 sts=4 sw=4:
197 
KIMIface::reachableContacts
virtual QStringList reachableContacts()=0
Obtain a list of KDE address book entries who are currently reachable.
KIMIface::allContacts
virtual QStringList allContacts()=0
Obtain a list of IM-contactable entries in the KDE address book.
KIMIface::chatWithContact
virtual void chatWithContact(const QString &uid)=0
Start a chat session with the specified addressee.
KIMIface::protocols
virtual QStringList protocols()=0
Discover what protocols the application supports.
KIMIface::onlineContacts
virtual QStringList onlineContacts()=0
Obtain a list of KDE address book entries who are currently online.
KIMIface
Generic DCOP interface for KDE instant messenger applications Note one omission of this interface is ...
Definition: kimiface.h:36
KIMIface::isPresent
virtual bool isPresent(const QString &uid)=0
Confirm if a given KABC uid is known to KIMProxy.
KIMIface::presence
k_dcop_signals QByteArray int presence
Definition: kimiface.h:182
KIMIface::icon
virtual QPixmap icon(const QString &uid)=0
Obtain the icon representing IM presence for the specified addressee.
KIMIface::presenceStatus
virtual int presenceStatus(const QString &uid)=0
Obtain the IM presence as a number (see KIMIface) for the specified addressee.
KIMIface::messageNewContact
virtual void messageNewContact(const QString &contactId, const QString &protocol)=0
Open a chat to a contact, and optionally set some initial text.
KIMIface::context
virtual QString context(const QString &uid)=0
Get the supplied addressee's current context (home, work, or any).
KIMIface::addContact
virtual bool addContact(const QString &contactId, const QString &protocol)=0
Add a contact to the contact list.
KIMIface::locate
virtual QString locate(const QString &contactId, const QString &protocol)=0
Get the KABC uid corresponding to the supplied IM address Protocols should be.
KIMIface::fileTransferContacts
virtual QStringList fileTransferContacts()=0
Obtain a list of KDE address book entries who may receive file transfers.
KIMIface::sendFile
virtual void sendFile(const QString &uid, const KUrl &sourceURL, const QString &altFileName=QString(), uint fileSize=0)=0
Send the file to the contact.
KIMIface::messageContact
virtual void messageContact(const QString &uid, const QString &message)=0
Send a single message to the specified addressee Any response will be handled by the IM client as a n...
KIMIface::canReceiveFiles
virtual bool canReceiveFiles(const QString &uid)=0
Indicate if a given uid can receive files.
KIMIface::displayName
virtual QString displayName(const QString &uid)=0
Obtain the IM app's idea of the contact's display name Useful if KABC lookups may be too slow...
DCOPObject
protocol
QString protocol
Definition: kopete-account-kconf_update.cpp:34
KIMIface::presenceString
virtual QString presenceString(const QString &uid)=0
Obtain the IM presence as a i18ned string for the specified addressee.
KIMIface::appId
k_dcop_signals QByteArray appId
Definition: kimiface.h:182
KIMIface::canRespond
virtual bool canRespond(const QString &uid)=0
Some media are unidirectional (eg, sending SMS via a web interface).
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:40 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