kopete/kopete

KopeteDBusInterface Class Reference

#include <kopetedbusinterface.h>

Inheritance diagram for KopeteDBusInterface:

[legend]

List of all members.

Detailed Description

Public D-Bus interface for Kopete.

Author:: Michaël Larouche <larouche@kde.org>

Definition at line 29 of file kopetedbusinterface.h.


Public Slots
void	connectAll ()
void	disconnectAll ()
bool	isConnected (const QString &protocolName, const QString &accountId)
void	connect (const QString &protocolName, const QString &accountId)
void	disconnect (const QString &protocolName, const QString &accountId)
QStringList	protocols () const
QStringList	identities () const
QStringList	accounts () const
QStringList	contacts () const
QString	labelForIdentity (const QString &id) const
QStringList	contactsByFilter (const QString &filter) const
void	setIdentityNickName (const QString &nickName, const QString &identityId=QString())
void	setIdentityAvatar (const QString &avatarUrl, const QString &identityId=QString())
void	setIdentityOnlineStatus (const QString &status, const QString &message, const QString &identityId=QString())
void	setOnlineStatus (const QString &status, const QString &message=QString())
void	setStatusMessage (const QString &message)
void	sendMessage (const QString &displayName, const QString &message)
bool	addContact (const QString &protocolName, const QString &accountId, const QString &contactId, const QString &displayName, const QString &groupName=QString())
void	sendFile (const QString &displayName, const QString &fileUrl)
Public Member Functions
	KopeteDBusInterface (QObject *parent)
	~KopeteDBusInterface ()

Constructor & Destructor Documentation

KopeteDBusInterface::KopeteDBusInterface ( QObject * parent )

Constructor.

Parameters:

parent

QObject parent

Definition at line 78 of file kopetedbusinterface.cpp.

KopeteDBusInterface::~KopeteDBusInterface ( )

Destructor.

Definition at line 86 of file kopetedbusinterface.cpp.

Member Function Documentation

void KopeteDBusInterface::connectAll ( ) [slot]

Connect all accounts.

Definition at line 238 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::disconnectAll ( ) [slot]

Disconnect all accounts.

Definition at line 243 of file kopetedbusinterface.cpp.

bool KopeteDBusInterface::isConnected	(	const QString &	protocolName,
		const QString &	accountId
	)			`[slot]`

Get information if we are connected to a given account in the given protocol.

Parameters:

	protocolName	The protocol name (ex: Jabber, Yahoo, Messenger)
	accountId	Account ID

Returns:: if the given protocolName and accountId are valid and we are connected then true is returned else false is returned.

Definition at line 324 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::connect	(	const QString &	protocolName,
		const QString &	accountId
	)			`[slot]`

Connect a given account in the given protocol.

Parameters:

	protocolName	The protocol name (ex: Jabber, Yahoo, Messenger)
	accountId	Account ID

Definition at line 336 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::disconnect	(	const QString &	protocolName,
		const QString &	accountId
	)			`[slot]`

Disconnect a given account in the given protocol.

Parameters:

	protocolName	The protocol name (ex: Jabber, Yahoo, Messenger)
	accountId	Account ID

Definition at line 351 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::protocols ( ) const [slot]

Get a list of all protocol names.

Returns:: a list of all protocol names.

Definition at line 90 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::identities ( ) const [slot]

Get a list of all identities' ID.

Returns:: a list of all identities' ID

Definition at line 203 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::accounts ( ) const [slot]

Get a list of all account's ID.

Returns:: a list of all accounts' ID

Definition at line 226 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::contacts ( ) const [slot]

Return all contacts.

Returns:: a list of all contacts display name

Definition at line 98 of file kopetedbusinterface.cpp.

QString KopeteDBusInterface::labelForIdentity ( const QString & id ) const [slot]

Get UI labels for identities.

Returns:: a label for a identity.

Definition at line 215 of file kopetedbusinterface.cpp.

QStringList KopeteDBusInterface::contactsByFilter ( const QString & filter ) const [slot]

Get a filered list of contacts based on the filter.

Accetable filters are: online, reachable, filecapable. If no accepted filters are provived, it will return an empty list.

Returns:: list of filtered contacts

Definition at line 103 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityNickName	(	const QString &	nickName,
		const QString &	identityId = `QString()`
	)			`[slot]`

Set the nickname for the given identity.

To set the nickname of the default identity, use an empty identityId

Parameters:

	nickName	New nickname of the identity
	identityId	Identity ID to modify. If empty, will use default identity.

Definition at line 138 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityAvatar	(	const QString &	avatarUrl,
		const QString &	identityId = `QString()`
	)			`[slot]`

Set the avatar for the given identity.

To set the avatar of the default identity, use an empty identityId

Parameters:

	avatarUrl	Path to the avatar image
	identityId	Identity ID to modify. If empty, will use default identity

Definition at line 157 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setIdentityOnlineStatus	(	const QString &	status,
		const QString &	message,
		const QString &	identityId = `QString()`
	)			`[slot]`

Set the online status for the given identity.

To set the online status of the default identity, use an empty identityId

Parameters:

	status	The english word for the status you want.
	message	Status message, can be an empty string
	identityId	Identity ID to modify. If empty, will use default identity

Definition at line 184 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setOnlineStatus	(	const QString &	status,
		const QString &	message = `QString()`
	)			`[slot]`

Change the online status for all accounts.

Accepted values for status are: Online, Busy, Away, Available

Parameters:

	status	The english word for the status you want.
	message	Optional status message

Definition at line 248 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::setStatusMessage ( const QString & message ) [slot]

Change the status message for all accounts.

Use an empty string to clear the status message

Parameters:

message

Status message

Definition at line 253 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::sendMessage	(	const QString &	displayName,
		const QString &	message
	)			`[slot]`

Send a message to the given contact.

Parameters:

	displayName	Metacontact display name to send a messasge
	message	The message to send

Definition at line 258 of file kopetedbusinterface.cpp.

bool KopeteDBusInterface::addContact	(	const QString &	protocolName,
		const QString &	accountId,
		const QString &	contactId,
		const QString &	displayName,
		const QString &	groupName = `QString()`
	)			`[slot]`

Adds a contact with the specified params.

Parameters:

	protocolName	The name of the protocol this contact is for ("Jabber", etc)
	accountId	The account ID to add the contact to
	contactId	The unique ID for this protocol
	displayName	The displayName of the contact (may equal userId for some protocols
	groupName	The name of the group to add the contact to

Returns:: Weather or not the contact was added successfully

Definition at line 275 of file kopetedbusinterface.cpp.

void KopeteDBusInterface::sendFile	(	const QString &	displayName,
		const QString &	fileUrl
	)			`[slot]`

Send a file to the given contact.

Parameters:

	displayName	Metacontact display name to send a file
	fileUrl	Url of the file to send

Definition at line 311 of file kopetedbusinterface.cpp.

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

kopete/kopete

KopeteDBusInterface Class Reference

Detailed Description

Public Slots

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

kopete/kopete

kdenetwork