Syndication::DataRetriever Class

class Syndication::DataRetriever

Abstract baseclass for all data retriever classes. More...

Header:	`#include <Syndication/DataRetriever>`
CMake:	`find_package(KF6 REQUIRED COMPONENTS Syndication)` `target_link_libraries(mytarget PRIVATE KF6::Syndication)`
Inherits:	QObject

List of all members, including inherited members

Public Functions

	DataRetriever()
virtual void	abort() = 0
virtual int	errorCode() const = 0
virtual void	retrieveData(const QUrl &url) = 0

Signals

void	dataRetrieved(const QByteArray &data, bool success)

Detailed Description

Subclass this to add a new retrieval algorithm which can then be plugged into the RSS loader.

See also Loader.

Member Function Documentation

DataRetriever::DataRetriever()

Default constructor.

`[pure virtual]` void DataRetriever::abort()

aborts the retrieval process.

`[signal]` void DataRetriever::dataRetrieved(const QByteArray &data, bool success)

Emit this signal to tell the Loader class that the retrieval process was finished.

data Should contain the retrieved data and will get parsed by the Loader class.

success Indicates whether there were any problems during the retrieval process. Pass 'true' to indicate that everything went seamlessy, 'false' to tell the Loader that something went wrong and that the data parameter might contain no or invalid data.

`[pure virtual]` int DataRetriever::errorCode() const

Returns an error code which might give a more precise information about what went wrong in case the 'success' flag returned with the dataRetrieved() signal was 'false'.

Note that the meaning of the returned integer depends on the actual data retriever.

`[pure virtual]` void DataRetriever::retrieveData(const QUrl &url)

Retrieve data from the given URL.

This method is supposed to get reimplemented by subclasses. It will be called by the Loader class in case it needs to retrieve the data.

url the URL to retrieve data from

See also Loader::loadFrom().

Contents