kopete/kopete

KIMIface Class Reference

#include <kimiface.h>

Inheritance diagram for KIMIface:

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 <wstephenson@kde.org>

Definition at line 37 of file kimiface.h.


DCOP Member Functions
virtual bool	addContact (const QString &contactId, const QString &protocol)=0
virtual QStringList	allContacts ()=0
virtual bool	canReceiveFiles (const QString &uid)=0
virtual bool	canRespond (const QString &uid)=0
virtual void	chatWithContact (const QString &uid)=0
virtual QString	context (const QString &uid)=0
virtual QString	displayName (const QString &uid)=0
virtual QStringList	fileTransferContacts ()=0
virtual QPixmap	icon (const QString &uid)=0
virtual bool	isPresent (const QString &uid)=0
virtual QString	locate (const QString &contactId, const QString &protocol)=0
virtual void	messageContact (const QString &uid, const QString &message)=0
virtual void	messageNewContact (const QString &contactId, const QString &protocol)=0
virtual QStringList	onlineContacts ()=0
virtual int	presenceStatus (const QString &uid)=0
virtual QString	presenceString (const QString &uid)=0
virtual QStringList	protocols ()=0
virtual QStringList	reachableContacts ()=0
virtual void	sendFile (const QString &uid, const KUrl &sourceURL, const QString &altFileName=QString(), uint fileSize=0)=0
Public Attributes
k_dcop_signals	__pad0__: void contactPresenceChanged( QString uid
k_dcop_signals QByteArray	appId
k_dcop_signals QByteArray int	presence

Member Function Documentation

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.

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:

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.

virtual QString KIMIface::context ( const QString & uid ) [pure virtual]

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.

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:

KABC

uid.

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:

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.

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:

	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.

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:

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)

virtual QString KIMIface::presenceString ( const QString & uid ) [pure virtual]

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.

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:

	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

Member Data Documentation

k_dcop_signals KIMIface::__pad0__

Definition at line 183 of file kimiface.h.

k_dcop_signals QByteArray KIMIface::appId

Definition at line 183 of file kimiface.h.

k_dcop_signals QByteArray int KIMIface::presence

Definition at line 183 of file kimiface.h.

The documentation for this class was generated from the following file:

kimiface.h

kopete/kopete

KIMIface Class Reference

Detailed Description

DCOP Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation

kopete/kopete

kdenetwork