LeechCraft Azoth  0.6.70-15082-g543737046d
Modular multiprotocol IM plugin for LeechCraft
LC::Azoth::RIEXItem Struct Reference

Represents a single exchange entry. More...

#include "isupportriex.h"

Public Types

enum  Action { AAdd, ADelete, AModify }
 What should be done with this item. More...
 

Public Attributes

enum LC::Azoth::RIEXItem::Action Action_
 
QString ID_
 The human-readable ID of the entry. More...
 
QString Nick_
 The suggested nickname of the entry. More...
 
QStringList Groups_
 The suggested groups for the entry. More...
 

Detailed Description

Represents a single exchange entry.

Definition at line 33 of file isupportriex.h.

Member Enumeration Documentation

◆ Action

What should be done with this item.

Since contact exchange is modelled after XEP-0144 ( http://xmpp.org/extensions/xep-0144.html ), the LeechCraft Core follows the recommended behavior while handling the items.

Enumerator
AAdd 

This item should be added to the roster.

ADelete 

This item should be removed from the roster.

AModify 

This item should be updated in the roster.

Definition at line 48 of file isupportriex.h.

Member Data Documentation

◆ Action_

enum LC::Azoth::RIEXItem::Action LC::Azoth::RIEXItem::Action_

◆ Groups_

QStringList LC::Azoth::RIEXItem::Groups_

The suggested groups for the entry.

This field may be empty.

The exact semantics of this field depend on the value of the Action_ field.

Definition at line 90 of file isupportriex.h.

◆ ID_

QString LC::Azoth::RIEXItem::ID_

The human-readable ID of the entry.

This field must be non-empty.

This is semantically equivalent to the return value of the ICLEntry::GetHumanReadableID(). The same semantics apply: basically, this ID must uniquely identify the target user in the protocol, but there is no need to make it unique LeechCraft-wide.

See also
ICLEntry::GetHumanReadableID().

Definition at line 75 of file isupportriex.h.

◆ Nick_

QString LC::Azoth::RIEXItem::Nick_

The suggested nickname of the entry.

This field may be empty.

Definition at line 81 of file isupportriex.h.


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