LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
IANEmitter Class Referenceabstract

Interface for plugins emitting AdvancedNotifications entries. More...

#include "ianemitter.h"

Public Member Functions

virtual ~IANEmitter ()=default
 
virtual QList< LC::ANFieldDataGetANFields () const =0
 Returns the list of additional fields. More...
 

Detailed Description

Interface for plugins emitting AdvancedNotifications entries.

This interface should be implemented by plugins that support the AdvancedNotifications framework, emit the corresponding entities and provide additional fields in those entities.

The list of additional fields is described by the list of corresponding structures returned from the GetANFields() member.

If a plugin doesn't define any additional fields, it may choose to not implement this interface.

See also
LC::ANFieldData

Definition at line 195 of file ianemitter.h.

Constructor & Destructor Documentation

◆ ~IANEmitter()

virtual IANEmitter::~IANEmitter ( )
virtualdefault

Member Function Documentation

◆ GetANFields()

virtual QList<LC::ANFieldData> IANEmitter::GetANFields ( ) const
pure virtual

Returns the list of additional fields.

This function returns the list of additional fields and their semantics that may be present in the notifications emitted by this plugin.

This list must not change during single run session.

Please refer to the documentation of the LC::ANFieldData structure for more information.

Returns
The list of additional AdvancedNotifications fields.
See also
LC::ANFieldData

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