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

kopete/kopete

Public Attributes | List of all members
KIMIface Class Referenceabstract

#include <kimiface.h>

Inheritance diagram for KIMIface:
Inheritance graph
[legend]

Public Attributes

k_dcop_signals __pad0__: void contactPresenceChanged( QString uid
 
k_dcop_signals QByteArray appId
 
k_dcop_signals QByteArray 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.

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.

Member Function Documentation

virtual bool KIMIface::addContact ( const QString &  contactId,
const QString &  protocol 
)
pure virtual

Add a contact to the contact list.

Parameters
contactIdthe protocol specific identifier for the contact, eg UIN for ICQ, screenname for AIM, nick for IRC.
protocolthe 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.
virtual QStringList KIMIface::allContacts ( )
pure virtual

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
uidthe 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
uidthe 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
uidthe KABC uid you want to chat with.
virtual QString KIMIface::context ( const QString &  uid)
pure virtual

Get the supplied addressee's current context (home, work, or any).

Parameters
uidthe KABC uid you want the context for.
Returns
A QString describing the context, or null if not supported.
virtual QString KIMIface::displayName ( const QString &  uid)
pure virtual

Obtain the IM app's idea of the contact's display name Useful if KABC lookups may be too slow.

Parameters
KABCuid.
Returns
The corresponding display name.
virtual QStringList KIMIface::fileTransferContacts ( )
pure virtual

Obtain a list of KDE address book entries who may receive file transfers.

Returns
a list of KABC uids capable of file transfer.
virtual QPixmap KIMIface::icon ( const QString &  uid)
pure virtual

Obtain the icon representing IM presence for the specified addressee.

Parameters
uidthe 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
uidthe KABC uid you are interested in.
Returns
whether one of the chat programs KIMProxy talks to knows of this KABC uid.
virtual QString KIMIface::locate ( const QString &  contactId,
const QString &  protocol 
)
pure virtual

Get the KABC uid corresponding to the supplied IM address Protocols should be.

Parameters
contactIdthe protocol specific identifier for the contact, eg UIN for ICQ, screenname for AIM, nick for IRC.
protocolthe 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
uidthe KABC uid you want to chat with.
messagethe 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.

virtual QStringList KIMIface::onlineContacts ( )
pure virtual

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
uidthe 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)
virtual QString KIMIface::presenceString ( const QString &  uid)
pure virtual

Obtain the IM presence as a i18ned string for the specified addressee.

Parameters
uidthe KABC uid you want the presence for.
Returns
the i18ned string describing presence.
virtual QStringList KIMIface::protocols ( )
pure virtual

Discover what protocols the application supports.

Returns
the set of protocols that the application supports
virtual QStringList KIMIface::reachableContacts ( )
pure virtual

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
uidthe KABC uid you are sending to.
sourceURLa KUrl to send.
altFileNamean alternate filename describing the file
fileSizefile size in bytes

Member Data Documentation

k_dcop_signals KIMIface::__pad0__

Definition at line 182 of file kimiface.h.

k_dcop_signals QByteArray KIMIface::appId

Definition at line 182 of file kimiface.h.

k_dcop_signals QByteArray int KIMIface::presence

Definition at line 182 of file kimiface.h.


The documentation for this class was generated from the following file:
  • kimiface.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:41 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