KIMIface Class Reference
Generic DCOP interface for KDE instant messenger applications Note one omission of this interface is the lack of control over the range of values used for protocols' names. More...
#include <kimiface.h>
Inheritance diagram for KIMIface:

DCOP Member Functions | |
virtual QStringList | allContacts ()=0 |
virtual QStringList | reachableContacts ()=0 |
virtual QStringList | onlineContacts ()=0 |
virtual QStringList | fileTransferContacts ()=0 |
virtual bool | isPresent (const QString &uid)=0 |
virtual QString | displayName (const QString &uid)=0 |
virtual QString | presenceString (const QString &uid)=0 |
virtual int | presenceStatus (const QString &uid)=0 |
virtual bool | canReceiveFiles (const QString &uid)=0 |
virtual bool | canRespond (const QString &uid)=0 |
virtual QString | locate (const QString &contactId, const QString &protocol)=0 |
virtual QPixmap | icon (const QString &uid)=0 |
virtual QString | context (const QString &uid)=0 |
virtual QStringList | protocols ()=0 |
virtual void | messageContact (const QString &uid, const QString &message)=0 |
virtual void | messageNewContact (const QString &contactId, const QString &protocol)=0 |
virtual void | chatWithContact (const QString &uid)=0 |
virtual void | sendFile (const QString &uid, const KURL &sourceURL, const QString &altFileName=QString::null, uint fileSize=0)=0 |
virtual bool | addContact (const QString &contactId, const QString &protocol)=0 |
Public Attributes | |
k_dcop_signals | __pad0__: void contactPresenceChanged( QString uid |
k_dcop_signals QCString | appId |
k_dcop_signals QCString int | presence |
Detailed Description
Generic DCOP interface for KDE instant messenger applications Note one omission of this interface is the lack of control over the range of values used for protocols' names.If you are implementing this interface, note that your application must have the following information in its desktop file, so that it can be identified as providing KIMIface at runtime: X-DCOP-ServiceName=<application name> ServiceTypes=DCOP/InstantMessenger and the class implementing KIMIface must pass "KIMIface" to the DCOPObject constructor.
- Since:
- 3.3
- Author:
- Will Stephenson <lists@stevello.free-online.co.uk>
Definition at line 43 of file kimiface.h.
Member Function Documentation
|
Obtain a list of IM-contactable entries in the KDE address book.
|
|
Obtain a list of KDE address book entries who are currently reachable.
|
|
Obtain a list of KDE address book entries who are currently online.
|
|
Obtain a list of KDE address book entries who may receive file transfers.
|
|
Confirm if a given contact is known to the IM application.
|
|
Obtain the IM app's idea of the contact's display name Useful if KABC lookups may be too slow.
|
|
Obtain the IM presence as a i18ned string for the specified contact.
|
|
Obtain the IM presence as a number for the specified contact.
|
|
Indicate if a given contact can receive files.
|
|
Some media are unidirectional (eg, sending SMS via a web interface). This refers to the contact's ability to respond as defined by the medium, not by their presence. Someone may appear offline (SMS has no presence) to you but in fact be able to respond.
|
|
Get the KABC uid corresponding to the supplied IM address.
|
|
Obtain the icon representing IM presence for the specified contact.
|
|
Get the supplied contact's current context (home, work, or any).
|
|
Discover what protocols the application supports.
|
|
Send a single message to the specified contact Any response will be handled by the IM client as a normal conversation.
|
|
Open a chat to a contact, and optionally set some initial text.
|
|
Start a chat session with the specified contact.
|
|
Send a file to the contact.
|
|
Add a contact to the contact list.
|
The documentation for this class was generated from the following file: