#include <Fuoten/API/GetFolders>

Inheritance diagram for GetFeeds:

Public Member Functions
	GetFeeds (QObject *parent=nullptr)

	~GetFeeds () override

Q_INVOKABLE void	execute () override

Public Member Functions inherited from Component
	Component (QObject *parent=nullptr)

	~Component () override

AbstractConfiguration *	configuration () const

Error *	error () const

bool	inOperation () const

bool	isUseStorageEnabled () const

AbstractNotificator *	notificator () const

quint16	requestTimeout () const

void	setConfiguration (AbstractConfiguration *nAbstractConfiguration)

void	setNotificator (AbstractNotificator *notificator)

void	setRequestTimeout (quint16 seconds)

void	setStorage (AbstractStorage *localStorage)

void	setUseStorage (bool useStorage)

void	setWipeManager (WipeManager *wipeManager)

AbstractStorage *	storage () const

WipeManager *	wipeManager () const

Protected Member Functions
bool	checkOutput () override

void	successCallback () override

Protected Member Functions inherited from Component
void	addRequestHeader (const QByteArray &headerName, const QByteArray &headerValue)

void	addRequestHeaders (const QHash< QByteArray, QByteArray > &headers)

virtual bool	checkInput ()

virtual void	extractError (QNetworkReply *reply)

QJsonDocument	jsonResult () const

void	notify (const Error *e) const

void	notify (AbstractNotificator::Type type, QtMsgType severity, const QVariant &data) const

QHash< QByteArray, QByteArray >	requestHeaders () const

void	sendRequest ()

void	setApiRoute (const QString &route)

void	setApiRoute (const QStringList &routeParts)

void	setError (Error *nError)

void	setExpectedJSONType (ExpectedJSONType type)

void	setInOperation (bool nInOperation)

void	setNetworkOperation (QNetworkAccessManager::Operation operation)

void	setPayload (const QByteArray &payload)

void	setPayload (const QJsonObject &payload)

void	setRequestHeaders (const QHash< QByteArray, QByteArray > &headers)

void	setRequiresAuth (bool reqAuth)

void	setUrlQuery (const QUrlQuery &query)

Additional Inherited Members
Public Types inherited from Component
enum	ExpectedJSONType : quint8 { Empty = 0, Array = 1, Object = 2 }

Properties inherited from Component
Fuoten::AbstractConfiguration	configuration

Fuoten::Error	error

bool	inOperation

Fuoten::AbstractNotificator	notificator

quint16	requestTimeout

Fuoten::AbstractStorage	storage

bool	useStorage

Fuoten::WipeManager	wipeManager

Signals inherited from Component
void	configurationChanged (Fuoten::AbstractConfiguration *configuration)

void	errorChanged (Fuoten::Error *error)

void	failed (Fuoten::Error *error)

void	inOperationChanged (bool inOperation)

void	notificatorChanged (Fuoten::AbstractNotificator *notificator)

void	requestTimeoutChanged (quint16 requestTimeout)

void	sslErrors (QNetworkReply *reply, const QList< QSslError > &errors)

void	storageChanged (Fuoten::AbstractStorage *storage)

void	succeeded (const QJsonDocument &result)

void	useStorageChanged (bool useStorage)

void	wipeManagerChanged (Fuoten::WipeManager *wipeManager)

Static Public Member Functions inherited from Component
static AbstractConfiguration *	defaultConfiguration ()

static AbstractNotificator *	defaultNotificator ()

static AbstractStorage *	defaultStorage ()

static WipeManager *	defaultWipeManager ()

static AbstractNamFactory *	networkAccessManagerFactory ()

static void	setDefaultConfiguration (AbstractConfiguration *config)

static void	setDefaultNotificator (AbstractNotificator *notificator)

static void	setDefaultStorage (AbstractStorage *storage)

static void	setDefaultWipeManager (WipeManager *wipeManager)

static void	setNetworkAccessManagerFactory (AbstractNamFactory *factory)

Detailed Description

Requests the list of feeds from the News App API.

To request the feeds list, the Component::configuration property has to be set to a valid AbstractConfiguration object. After setting it, call execute() to perform the API request.

If a valid AbstractStorage object is set to the Component::storage property, AbstractStorage::feedsRequested will be called in the successCallback() to save the requested folders in the local storage. If the request succeeded, the Component::succeeded() signal will be emitted, containing the JSON api reply.

If something failed, Component::failed() will be emitted and the Component::error property will contain a valid pointer to an Error object.

Mandatory properties: Component::configuration

API route: /feeds

Method: GET

See also: Synchronizer

Constructor & Destructor Documentation

◆ GetFeeds()

GetFeeds ( QObject * parent = nullptr )

explicit

Constructs an API request object with the given parent to query feeds from the remote server.

◆ ~GetFeeds()

~GetFeeds ( )

override

Destroys the GetFeeds object.

Member Function Documentation

◆ checkOutput()

bool checkOutput ( )

overrideprotectedvirtual

Checks for a feeds array in the JSON API reply.

Will at first perform the checks from Component::checkOutput() and will than check if the feeds array is present. Will not check if the array is empty.

Reimplemented from Component.

◆ execute()

void execute ( )

overridevirtual

Executes the API request.

To perform a successful API request, Component::configuration has to be set to a valid AbstractConfiguration object.

Execution will not run if Component::inOperation returns true and will itself set that property to true when start to perform the request.

Implements Component.

◆ successCallback()

void successCallback ( )

overrideprotectedvirtual

Finishes the the operation if the request was successful.

If Component::storage points to a valid object, it will use AbstractStorage::feedsRequested() to store, update and delete the feeds in the local storage according to the server reply. Afterwards it will set Component::inOperation to false and will emit the Component::succeeded() signal.