LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Azoth::ISupportActivity Class Referenceabstract

Interface for accounts supporting user activity. More...

#include "isupportactivity.h"

Public Member Functions

virtual ~ISupportActivity ()
 
virtual void SetActivity (const QString &general, const QString &specific, const QString &text)=0
 Publishes the current user activity. More...
 

Detailed Description

Interface for accounts supporting user activity.

This interface can be implemented by account objects to advertise the support for publishing current user activity.

The activities concept in Azoth is based on the XMPP XEP-0108: User Activities (http://xmpp.org/extensions/xep-0108.html).

See Also
IAccount

Definition at line 48 of file isupportactivity.h.

Constructor & Destructor Documentation

virtual LeechCraft::Azoth::ISupportActivity::~ISupportActivity ( )
inlinevirtual

Definition at line 51 of file isupportactivity.h.

Member Function Documentation

virtual void LeechCraft::Azoth::ISupportActivity::SetActivity ( const QString &  general,
const QString &  specific,
const QString &  text 
)
pure virtual

Publishes the current user activity.

The activity information is divided into three pieces: general activity (required), specific activity (optional) and an optional text.

The possible values of the general and specific fields are listed in http://xmpp.org/extensions/xep-0108.html.

Parameters
[in]generalThe general activity.
[in]specificThe specific activity (optional).
[in]textThe additional text message (optional).

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