MarkFeedRead Class Reference

#include <Fuoten/API/MarkFeedRead>

Inheritance diagram for MarkFeedRead:

Properties
qint64	feedId
qint64	newestItemId
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

Public Member Functions
	MarkFeedRead (QObject *parent=nullptr)
	~MarkFeedRead () override
Q_INVOKABLE void	execute () override
qint64	feedId () const
qint64	newestItemId () const
void	setFeedId (qint64 nFeedId)
void	setNewestItemId (qint64 nNewestItemId)
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

Signals
void	feedIdChanged (qint64 feedId)
void	newestItemIdChanged (qint64 newestItemId)
void	succeeded (qint64 feedId, qint64 newestItemId)
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)

Protected Member Functions
bool	checkInput () override
void	extractError (QNetworkReply *reply) 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	checkOutput ()
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 }
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

Marks all articles in a feed as read on the News App server.

To mark an entire feed as read, you have to set valid values to MarkFeedRead::feedId, MarkFeedRead::newestItemId and Component::configuration. After setting the mandatory properties, call execute() to perform the API request.

If a valid AbstractStorage object is set to the Component::storage property, AbstractStorage::feedMarkedRead() will be called in the successCallback() to update the local storage. If the request succeeded, the MarkFeedRead::succeeded() signal will be emitted, containing the feedId and the newestItemId. If something failed, the Component::failed() signal will be emitted and Component::error will contain a valid pointer to an Error object.

Mandatory properties

MarkFeedRead::feedId, MarkFeedRead::newestItemId, Component::configuration

API route

/feeds/{feedId}/read

Method

PUT

Property Documentation

feedId

qint64 feedId

readwrite

ID of the feed to mark as read.

This property can not be changed while Component::inOperation() returns true.

Access functions:

qint64	feedId() const
void	setFeedId(qint64 nFeedId)

Notifier signal:

void	feedIdChanged(qint64 feedId)

newestItemId

qint64 newestItemId

readwrite

ID of the newest local available item in the feed.

This property can not be changed while Component::inOperation() returns true.

Access functions:

qint64	newestItemId() const
void	setNewestItemId(qint64 nNewestItemId)

Notifier signal:

void	newestItemIdChanged(qint64 newestItemId)

Constructor & Destructor Documentation

MarkFeedRead()

MarkFeedRead ( QObject *  parent = nullptr )

explicit

Constructs an API request object with the given parent to mark an entire feed as read on the remote server.

~MarkFeedRead()

~MarkFeedRead ( )

override

Destroys the MarkFeedRead object.

Member Function Documentation

checkInput()

bool checkInput ( )

overrideprotectedvirtual

Will check for valid feedId and newestItemId.

Will at first perform the checks of Component::checkInput(). Will than simply check if the IDs are not lower or equal to 0.

Reimplemented from Component.

execute()

void execute ( )

overridevirtual

Executes the API request.

To perform a successful API request to mark a folder as read, MarkFeedRead::feedId and MarkFeedRead::newestItemId have to be valid IDs and there has to be an AbstractConfiguration object set to Component::configuration.

Execution will not run while Component::inOperation returns true and will itself set that property to true when the request starts.

Implements Component.

extractError()

void extractError ( QNetworkReply *  reply )

overrideprotectedvirtual

Extracts possible errors replied by the News App API.

Reimplemented from Component.

feedId()

qint64 feedId

(

)

const

Returns the ID of the feed to be marked as read.

See also

feedId

feedIdChanged

void feedIdChanged ( qint64  feedId )

signal

This signal is emitted if the ID of the feed to mark as read changes.

See also

feedId

newestItemId()

qint64 newestItemId

(

)

const

Returns the ID of the newest item in the feed.

See also

newestItemId

newestItemIdChanged

void newestItemIdChanged ( qint64  newestItemId )

signal

This signal is emitted if the ID of the newest item in the feed changes.

See also

newestItemId

setFeedId()

void setFeedId

(

qint64

nFeedId

)

Sets the ID of the feed to be marked as read.

See also

feedId

setNewestItemId()

void setNewestItemId

(

qint64

nNewestItemId

)

Sets the ID of the newest item in the feed.

See also

newestItemId

succeeded

void succeeded ( qint64  feedId, qint64  newestItemId  )

signal

This signal is emitted if the request to mark a feed as read was successful.

Parameters

feedId	ID of the feed that has been marked as read
newestItemId	ID of the newest local available item in the feed.

successCallback()

void successCallback ( )

overrideprotectedvirtual

Finishes the feed marking if the request was successful.

If Component::storage contains a valid pointer, the AbstractStorage::feedMarkedRead() function will be called to update the local storage. After that the Component::inOperation property will be set to false and the succeeded() signal will be emitted.

Implements Component.