kopete/kopete
#include <kimiface.h>
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.
- Author
- Will Stephenson wstep.nosp@m.hens.nosp@m.on@kd.nosp@m.e.or.nosp@m.g
Definition at line 36 of file kimiface.h.
virtual bool KIMIface::addContact |
( |
const QString & |
contactId, |
|
|
const QString & |
protocol |
|
) |
| |
|
pure virtual |
Add a contact to the contact list.
- Parameters
-
contactId | the protocol specific identifier for the contact, eg UIN for ICQ, screenname for AIM, nick for IRC. |
protocol | the protocol, eg one of "AIMProtocol", "MSNProtocol", "ICQProtocol", ... |
- Returns
- whether the add succeeded. False may signal already present, protocol not supported, or add operation not supported.
Obtain a list of IM-contactable entries in the KDE address book.
- Returns
- a list of KABC uids.
virtual bool KIMIface::canReceiveFiles |
( |
const QString & |
uid | ) |
|
|
pure virtual |
Indicate if a given uid can receive files.
- Parameters
-
uid | the KABC uid you are interested in. |
- Returns
- Whether the specified addressee can receive files.
virtual bool KIMIface::canRespond |
( |
const QString & |
uid | ) |
|
|
pure virtual |
Some media are unidirectional (eg, sending SMS via a web interface).
- Parameters
-
uid | the KABC uid you are interested in. |
- Returns
- Whether the specified addressee can respond.
virtual void KIMIface::chatWithContact |
( |
const QString & |
uid | ) |
|
|
pure virtual |
Start a chat session with the specified addressee.
- Parameters
-
uid | the KABC uid you want to chat with. |
Get the supplied addressee's current context (home, work, or any).
- Parameters
-
uid | the KABC uid you want the context for. |
- Returns
- A QString describing the context, or null if not supported.
Obtain the IM app's idea of the contact's display name Useful if KABC lookups may be too slow.
- Parameters
-
- Returns
- The corresponding display name.
Obtain a list of KDE address book entries who may receive file transfers.
- Returns
- a list of KABC uids capable of file transfer.
Obtain the icon representing IM presence for the specified addressee.
- Parameters
-
uid | the KABC uid you want the presence for. |
- Returns
- a pixmap representing the uid's presence.
virtual bool KIMIface::isPresent |
( |
const QString & |
uid | ) |
|
|
pure virtual |
Confirm if a given KABC uid is known to KIMProxy.
- Parameters
-
uid | the KABC uid you are interested in. |
- Returns
- whether one of the chat programs KIMProxy talks to knows of this KABC uid.
Get the KABC uid corresponding to the supplied IM address Protocols should be.
- Parameters
-
contactId | the protocol specific identifier for the contact, eg UIN for ICQ, screenname for AIM, nick for IRC. |
protocol | the protocol, eg one of "AIMProtocol", "MSNProtocol", "ICQProtocol", |
- Returns
- a KABC uid or null if none found/
virtual void KIMIface::messageContact |
( |
const QString & |
uid, |
|
|
const QString & |
message |
|
) |
| |
|
pure virtual |
Send a single message to the specified addressee Any response will be handled by the IM client as a normal conversation.
- Parameters
-
uid | the KABC uid you want to chat with. |
message | the message to send them. |
virtual void KIMIface::messageNewContact |
( |
const QString & |
contactId, |
|
|
const QString & |
protocol |
|
) |
| |
|
pure virtual |
Open a chat to a contact, and optionally set some initial text.
Obtain a list of KDE address book entries who are currently online.
- Returns
- a list of KABC uids who are online with unspecified presence.
virtual int KIMIface::presenceStatus |
( |
const QString & |
uid | ) |
|
|
pure virtual |
Obtain the IM presence as a number (see KIMIface) for the specified addressee.
- Parameters
-
uid | the KABC uid you want the presence for. |
- Returns
- a numeric representation of presence - currently one of 0 (Unknown), 1 (Offline), 2 (Connecting), 3 (Away), 4 (Online)
Obtain the IM presence as a i18ned string for the specified addressee.
- Parameters
-
uid | the KABC uid you want the presence for. |
- Returns
- the i18ned string describing presence.
Discover what protocols the application supports.
- Returns
- the set of protocols that the application supports
Obtain a list of KDE address book entries who are currently reachable.
- Returns
- a list of KABC uids who can receive a message, even if online.
virtual void KIMIface::sendFile |
( |
const QString & |
uid, |
|
|
const KUrl & |
sourceURL, |
|
|
const QString & |
altFileName = QString() , |
|
|
uint |
fileSize = 0 |
|
) |
| |
|
pure virtual |
Send the file to the contact.
- Parameters
-
uid | the KABC uid you are sending to. |
sourceURL | a KUrl to send. |
altFileName | an alternate filename describing the file |
fileSize | file size in bytes |
k_dcop_signals KIMIface::__pad0__ |
The documentation for this class was generated from the following file:
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.