Base class for RestLink plugins that provide custom request handlers. More...

#include <plugin.h>

Inherits QObject.

Public Member Functions
	Plugin (QObject *parent=nullptr)
	Constructs a Plugin instance.

virtual	~Plugin ()
	Destroys the Plugin instance.

QString	uuid () const
	Returns the plugin UUID from metadata.

QString	name () const
	Returns the plugin name from metadata.

QJsonObject	metaData () const
	Returns the raw plugin metadata.

void	setMetaData (const QJsonObject &metaData)
	Sets the plugin metadata.

virtual AbstractRequestHandler *	createHandler ()=0

Properties
QString	uuid

QString	name

Detailed Description

Base class for RestLink plugins that provide custom request handlers.

Plugins implementing this class can be dynamically loaded and are expected to return an instance of AbstractRequestHandler via createHandler(). Metadata such as UUID and name can be attached using setMetaData().

When creating a plugin, consider the RESTLINK_PLUGIN_IID macro for the IID.

Constructor & Destructor Documentation

◆ Plugin()

RestLink::Plugin::Plugin ( QObject * parent = nullptr )

explicit

Constructs a Plugin instance.

Parameters

parent The parent QObject.

◆ ~Plugin()

RestLink::Plugin::~Plugin ( )

virtual

Destroys the Plugin instance.

Member Function Documentation

◆ uuid()

QString RestLink::Plugin::uuid ( ) const

Returns the plugin UUID from metadata.

Returns: UUID as a QString.

◆ name()

QString RestLink::Plugin::name ( ) const

Returns the plugin name from metadata.

Returns: Name as a QString.

◆ metaData()

QJsonObject RestLink::Plugin::metaData ( ) const

Returns the raw plugin metadata.

Returns: A QJsonObject containing metadata.

◆ setMetaData()

void RestLink::Plugin::setMetaData ( const QJsonObject & metaData )

Sets the plugin metadata.

Parameters

metaData A QJsonObject containing metadata fields such as uuid and name.

◆ createHandler()

virtual AbstractRequestHandler * RestLink::Plugin::createHandler ( )

pure virtual

Property Documentation

◆ uuid

QString RestLink::Plugin::uuid

read

◆ name

QString RestLink::Plugin::name