LeechCraft Azoth  0.6.70-15082-g543737046d
Modular multiprotocol IM plugin for LeechCraft
LC::Azoth::IURIHandler Class Referenceabstract

This interface is for protocols that may handle URIs and corresponding actions are dependent on an exact account. More...

#include "iurihandler.h"

Public Member Functions

virtual ~IURIHandler ()
 
virtual bool SupportsURI (const QUrl &uri) const =0
 Queries whether the given URI is supported. More...
 
virtual void HandleURI (const QUrl &uri, QObject *asAccount)=0
 Asks to handle the given URI by the given account. More...
 

Detailed Description

This interface is for protocols that may handle URIs and corresponding actions are dependent on an exact account.

The protocols that implement this interface are queried by the Azoth Core whenever an URI should be checked if it could be handled. If a protocol defines that it supports a given URI by returning true from SupportsURI() method, then Core queries for the list of accounts of this protocol and asks user to select one that should be used to handle the URI.

If several different protocols show that they support a given URI, then accounts from all of them would be suggested to the user.

Definition at line 44 of file iurihandler.h.

Constructor & Destructor Documentation

◆ ~IURIHandler()

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

Definition at line 53 of file iurihandler.h.

Member Function Documentation

◆ HandleURI()

virtual void LC::Azoth::IURIHandler::HandleURI ( const QUrl &  uri,
QObject *  asAccount 
)
pure virtual

Asks to handle the given URI by the given account.

The account is selected by the user from the list of accounts of this protocol if SupportsURI() returned true for the given URI.

Parameters
[in]uriThe URI to handle.
[in]asAccountThe account to use to handle this URI.

◆ SupportsURI()

virtual bool LC::Azoth::IURIHandler::SupportsURI ( const QUrl &  uri) const
pure virtual

Queries whether the given URI is supported.

Parameters
[in]uriThe URI to query.
Returns
Whether this URI could be handled by an account of this protocol.

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