LeechCraft Azoth 0.6.70-14794-g33744ae6ce
Modular multiprotocol IM plugin for LeechCraft
Loading...
Searching...
No Matches
LC::Azoth::ISupportRIEX Class Referenceabstract

Interface representing Roster Item Exchange-like things. More...

#include "isupportriex.h"

Public Member Functions

virtual ~ISupportRIEX ()
 
virtual void SuggestItems (QList< RIEXItem > items, QObject *entry, QString message)=0
 Sends exchange request to the given entry.
 
virtual void riexItemsSuggested (QList< LC::Azoth::RIEXItem > items, QObject *from, QString message)=0
 Notifies that other part suggested modifying roster.
 

Detailed Description

Interface representing Roster Item Exchange-like things.

This interface should be implemented by account objects that support exchanging contact list items between different users.

This interface is modeled after XEP-0144.

Definition at line 90 of file isupportriex.h.

Constructor & Destructor Documentation

◆ ~ISupportRIEX()

virtual LC::Azoth::ISupportRIEX::~ISupportRIEX ( )
inlinevirtual

Definition at line 93 of file isupportriex.h.

Member Function Documentation

◆ riexItemsSuggested()

virtual void LC::Azoth::ISupportRIEX::riexItemsSuggested ( QList< LC::Azoth::RIEXItem items,
QObject *  from,
QString  message 
)
pure virtual

Notifies that other part suggested modifying roster.

This signal should be emitted whenever a remote part suggests adding, deleting or modifying items in the target user's contact list.

Some protocols may allow pushing items to the roster without any source contact present. In this case, the from parameter may be set to null.

Note
This function is expected to be a signal.
Parameters
[out]itemsThe list of items suggested.
[out]fromThe contact that suggested adding the entry, or null if not applicable. Must implement ICLEntr.
[out]messageOptional reason message.

◆ SuggestItems()

virtual void LC::Azoth::ISupportRIEX::SuggestItems ( QList< RIEXItem items,
QObject *  entry,
QString  message 
)
pure virtual

Sends exchange request to the given entry.

This function should send the given items to the given entry.

Parameters
[in]itemsThe list of items to be shared (added, deleted or modified).
[in]entryThe target entry whom the items should be sent.
[in]messageOptional reason message.

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