Requests updated items/articles from the News App API. More...

#include <Fuoten/API/GetUpdatedItems>

Inheritance diagram for Fuoten::GetUpdatedItems:

Properties
QDateTime	lastModified
	Return only items with a lastModified timestamp >= this one.
qint64	parentId
	ID of the folder or feed, use 0 for Starred and All.
Fuoten::FuotenEnums::Type	type
	Type of the query.
Properties inherited from Fuoten::Component
Fuoten::AbstractConfiguration *	configuration
	Pointer to an AbstractConfiguration derived object.
Fuoten::Error *	error
	Pointer to an error object, if any error occurred.
bool	inOperation
	Returns true while the request is in operation.
Fuoten::AbstractNotificator *	notificator
	Pointer to an object derived from AbstractNotificator.
quint16	requestTimeout
	Timeout in seconds for network requests.
Fuoten::AbstractStorage *	storage
	Pointer to an AbstractStorage derived object.
bool	useStorage
	If `true` (the default), a local storage should be used in the successCallback() function to further process the request results.
Fuoten::WipeManager *	wipeManager
	Pointer to a WipeManager to handle remote wipe requests.

Public Member Functions
	GetUpdatedItems (const QDateTime &lastModified, FuotenEnums::Type type, qint64 parentId, QObject *parent=nullptr)
	Constructs a new GetUpdatedItems object with the given arguments and parent.
	GetUpdatedItems (QObject *parent=nullptr)
	Constructs a new GetUpdatedItems object with default values and the given parent.
	~GetUpdatedItems () override
	Destroys the GetUpdatedItems object.
Q_INVOKABLE void	execute () override
	Executes the API request.
QDateTime	lastModified () const
	Getter function for the lastModified property.
qint64	parentId () const
	Getter function for the parentId property.
void	setLastModified (const QDateTime &nLastModified)
	Setter function for the lastModified property. Emits the lastModifiedChanged() signal if nLastModified is not equal to the stored value.
void	setParentId (qint64 nParentId)
	Setter function for the parentId property. Emits the parentIdChanged() signal if nParentId is not equal to the stored value.
void	setType (FuotenEnums::Type nType)
	Setter function for the type property. Emits the typeChanged() signal if nType is not equal to the stored value.
FuotenEnums::Type	type () const
	Getter function for the type property.
Public Member Functions inherited from Fuoten::Component
	Component (QObject *parent=nullptr)
	Constructs a component with the given parent.
	~Component () override
	Destroys the Component object.
AbstractConfiguration *	configuration () const
	Returns a pointer to the AbstractConfiguration that is currently set.
Error *	error () const
	Returns a pointer to an Error object, if any error occurred.
bool	inOperation () const
	Returns true while the API request is running.
bool	isUseStorageEnabled () const
	Getter function for the useStorage property.
AbstractNotificator *	notificator () const
	Getter function for the notificator property.
quint16	requestTimeout () const
	Returns the currently set request timeout.
void	setConfiguration (AbstractConfiguration *nAbstractConfiguration)
	Sets a pointer to a AbstractConfiguration to use for the API request.
void	setNotificator (AbstractNotificator *notificator)
	Setter function for the notificator property.
void	setRequestTimeout (quint16 seconds)
	Sets the timeout for the API request in seconds.
void	setStorage (AbstractStorage *localStorage)
	Setter function for the storage property.
void	setUseStorage (bool useStorage)
	Setter function for the useStorage property.
void	setWipeManager (WipeManager *wipeManager)
	Setter function for the wipeManager property.
AbstractStorage *	storage () const
	Getter function for the storage property.
WipeManager *	wipeManager () const
	Getter function for the wipeManager property.

Signals
void	lastModifiedChanged (const QDateTime &lastModified)
	This is emitted if the value of the lastModified property changes.
void	parentIdChanged (qint64 parentId)
	This is emitted if the value of the parentId property changes.
void	typeChanged (FuotenEnums::Type type)
	This is emitted if the value of the type property changes.
Signals inherited from Fuoten::Component
void	configurationChanged (Fuoten::AbstractConfiguration *configuration)
	This signal is emitted when the pointer to the AbstractConfiguration object changes.
void	errorChanged (Fuoten::Error *error)
	This signal is emitted when the pointer to the Error object changes. error will be a nullptr if no error occurred or the current error has been reset.
void	failed (Fuoten::Error *error)
	Emit this signal in a subclass when the request failed for some reason.
void	inOperationChanged (bool inOperation)
	This signal is emitted when the in operation status changes.
void	notificatorChanged (Fuoten::AbstractNotificator *notificator)
	Notifier signal for the notificator property.
void	requestTimeoutChanged (quint16 requestTimeout)
	This signal is emitte when the timeout for the request changes.
void	sslErrors (QNetworkReply *reply, const QList< QSslError > &errors)
	This signal is emitted if the SSL/TLS session encountered errors during the set up.
void	storageChanged (Fuoten::AbstractStorage *storage)
	Notifier signal for the storage property.
void	succeeded (const QJsonDocument &result)
	Emit this signal in a subclass when the request was successful.
void	useStorageChanged (bool useStorage)
	Notifier signal for the useStorage property.
void	wipeManagerChanged (Fuoten::WipeManager *wipeManager)
	Notifier signal for the wipeManager property.

Protected Member Functions
bool	checkInput () override
	Checks for valid input values.
bool	checkOutput () override
	Checks for an items array in the JSON API reply.
void	successCallback () override
	Finishes the the operation if the request was successful.
Protected Member Functions inherited from Fuoten::Component
void	addRequestHeader (const QByteArray &headerName, const QByteArray &headerValue)
	Adds a header to the HTTP request.
void	addRequestHeaders (const QHash< QByteArray, QByteArray > &headers)
	Adds headers to the HTTP request.
virtual void	extractError (QNetworkReply *reply)
	Extracts error data from the network reply.
QJsonDocument	jsonResult () const
	Returns the JSON result document.
void	notify (AbstractNotificator::Type type, QtMsgType severity, const QVariant &data) const
	Checks if a notificator has been set and will use it to notify the user.
void	notify (const Error *e) const
	Checks if a notificator has been set and will use it to notify about an occured error.
QHash< QByteArray, QByteArray >	requestHeaders () const
	Returns the currently set HTTP headers for the request.
void	sendRequest ()
	Sends the request to the server.
void	setApiRoute (const QString &route)
	Sets the API route.
void	setApiRoute (const QStringList &routeParts)
	Sets the API route constructed from a route part list.
void	setError (Error *nError)
	Sets the pointer of the error property.
void	setExpectedJSONType (ExpectedJSONType type)
	Sets the expected JSON type for initial output check.
void	setInOperation (bool nInOperation)
	Sets the value of the inOperation property.
void	setNetworkOperation (QNetworkAccessManager::Operation operation)
	Sets the operation the network manager should perform for this call.
void	setPayload (const QByteArray &payload)
	Sets the payload for the request.
void	setPayload (const QJsonObject &payload)
	Sets the payload for the request.
void	setRequestHeaders (const QHash< QByteArray, QByteArray > &headers)
	Sets the headers to use for the HTTP request.
void	setRequiresAuth (bool reqAuth)
	Set this to true if the request requires authentication.
void	setUrlQuery (const QUrlQuery &query)
	Sets the URL query for the request.

Additional Inherited Members
Public Types inherited from Fuoten::Component
enum	ExpectedJSONType : quint8 { Empty = 0 , Array = 1 , Object = 2 }
	Defines the expected JSON type. More...
Static Public Member Functions inherited from Fuoten::Component
static AbstractConfiguration *	defaultConfiguration ()
	Returns the global default configuration.
static QNetworkAccessManager *	defaultNam ()
	Returns the global network access manager.
static AbstractNotificator *	defaultNotificator ()
	Returns the global default notificator.
static AbstractStorage *	defaultStorage ()
	Returns the global default storage.
static WipeManager *	defaultWipeManager ()
	Returns the global default wipe manager.
static AbstractNamFactory *	networkAccessManagerFactory ()
	Returns the currently set network access manager factory.
static void	setDefaultConfiguration (AbstractConfiguration *config)
	Sets the global default configuration.
static void	setDefaultNam (QNetworkAccessManager *nam)
	Sets the global default network access manager.
static void	setDefaultNotificator (AbstractNotificator *notificator)
	Sets the global default notificator.
static void	setDefaultStorage (AbstractStorage *storage)
	Sets the global default storage.
static void	setDefaultWipeManager (WipeManager *wipeManager)
	Sets the global default wipe manager.
static void	setNetworkAccessManagerFactory (AbstractNamFactory *factory)
	Sets the network access manager factory. The factory will be used to create QNetworkAccessManager objects on demand. If no factory is set, a default QNetworkAccessManager object will be created. The Component class will take ownership of the created QNetworkAccessManager.

Detailed Description

Requests updated items/articles from the News App API.

To request updated items/articles, the Component::configuration property has to be set to a valid AbstractConfiguration object and a valid timestamp has to be set to GetUpdatedItems::lastModified. 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::itemsRequested will be called in the successCallback() to save the requested items 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, GetUpdatedItems::lastModified

API route: /items/updated

Method: GET

See also: Synchronizer

Property Documentation

◆ lastModified

QDateTime Fuoten::GetUpdatedItems::lastModified

readwrite

Return only items with a lastModified timestamp >= this one.

This may also return already existing items whose read or starred status has been changed. This property can not be changed while Component::inOperation() returns true.

Access functions:

QDateTime	lastModified() const
void	setLastModified(const QDateTime &nLastModified)

Notifier signal:

void	lastModifiedChanged(const QDateTime &lastModified)

◆ parentId

qint64 Fuoten::GetUpdatedItems::parentId

readwrite

ID of the folder or feed, use 0 for Starred and All.

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

Access functions:

qint64	parentId() const
void	setParentId(qint64 nParentId)

Notifier signal:

void	parentIdChanged(qint64 parentId)

◆ type

Fuoten::FuotenEnums::Type Fuoten::GetUpdatedItems::type

readwrite

Type of the query.

Defaults to FuotenEnums::All. This property can not be changed while Component::inOperation() returns true.

Access functions:

FuotenEnums::Type	type() const
void	setType(FuotenEnums::Type nType)

Notifier signal:

void	typeChanged(FuotenEnums::Type type)

Constructor & Destructor Documentation

◆ GetUpdatedItems() [1/2]

GetUpdatedItems::GetUpdatedItems ( QObject * parent = nullptr )

explicit

Constructs a new GetUpdatedItems object with default values and the given parent.

◆ GetUpdatedItems() [2/2]

GetUpdatedItems::GetUpdatedItems	(	const QDateTime &	lastModified,
		FuotenEnums::Type	type,
		qint64	parentId,
		QObject *	parent = nullptr )

Constructs a new GetUpdatedItems object with the given arguments and parent.

◆ ~GetUpdatedItems()

GetUpdatedItems::~GetUpdatedItems ( )

override

Destroys the GetUpdatedItems object.

Member Function Documentation

◆ checkInput()

bool GetUpdatedItems::checkInput ( )

overrideprotectedvirtual

Checks for valid input values.

Will at first perfrom the checks from Component::checkInput() and will than check if the values of the properties are in valid ranges.

Reimplemented from Fuoten::Component.

◆ checkOutput()

bool GetUpdatedItems::checkOutput ( )

overrideprotectedvirtual

Checks for an items array in the JSON API reply.

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

Reimplemented from Fuoten::Component.

◆ execute()

void GetUpdatedItems::execute ( )

overridevirtual

Executes the API request.

To perform a successful API request, Component::configuration has to be set to a valid AbstractConfiguration object and GetUpdatedItems::lastModified has to contain a valid time.

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

Implements Fuoten::Component.

◆ lastModified()

QDateTime GetUpdatedItems::lastModified ( ) const

Getter function for the lastModified property.

See also: GetUpdatedItems::setLastModified(), GetUpdatedItems::lastModifiedChanged()

◆ lastModifiedChanged

void Fuoten::GetUpdatedItems::lastModifiedChanged ( const QDateTime & lastModified )

signal

This is emitted if the value of the lastModified property changes.

See also: GetUpdatedItems::lastModified(), GetUpdatedItems::setLastModified()

◆ parentId()

qint64 GetUpdatedItems::parentId ( ) const

Getter function for the parentId property.

See also: GetUpdatedItems::setParentId(), GetUpdatedItems::parentIdChanged()

◆ parentIdChanged

void Fuoten::GetUpdatedItems::parentIdChanged ( qint64 parentId )

signal

This is emitted if the value of the parentId property changes.

See also: GetUpdatedItems::parentId(), GetUpdatedItems::setParentId()

◆ setLastModified()

void GetUpdatedItems::setLastModified ( const QDateTime & nLastModified )

Setter function for the lastModified property. Emits the lastModifiedChanged() signal if nLastModified is not equal to the stored value.

See also: GetUpdatedItems::lastModified(), GetUpdatedItems::lastModifiedChanged()

◆ setParentId()

void GetUpdatedItems::setParentId ( qint64 nParentId )

Setter function for the parentId property. Emits the parentIdChanged() signal if nParentId is not equal to the stored value.

See also: GetUpdatedItems::parentId(), GetUpdatedItems::parentIdChanged()

◆ setType()

void GetUpdatedItems::setType ( FuotenEnums::Type nType )

Setter function for the type property. Emits the typeChanged() signal if nType is not equal to the stored value.

See also: GetUpdatedItems::type(), GetUpdatedItems::typeChanged()

◆ successCallback()

void GetUpdatedItems::successCallback ( )

overrideprotectedvirtual

Finishes the the operation if the request was successful.

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

Implements Fuoten::Component.

◆ type()

FuotenEnums::Type GetUpdatedItems::type ( ) const

Getter function for the type property.

See also: GetUpdatedItems::setType(), GetUpdatedItems::typeChanged()

◆ typeChanged

void Fuoten::GetUpdatedItems::typeChanged ( FuotenEnums::Type type )

signal

This is emitted if the value of the type property changes.

See also: GetUpdatedItems::type(), GetUpdatedItems::setType()

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

Fuoten/API/getupdateditems.h
build/Fuoten/FuotenQt5_autogen/include/moc_getupdateditems.cpp
Fuoten/API/getupdateditems.cpp

Properties

Public Member Functions

Signals

Protected Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ lastModified

◆ parentId

◆ type

Constructor & Destructor Documentation

◆ GetUpdatedItems() [1/2]

◆ GetUpdatedItems() [2/2]

◆ ~GetUpdatedItems()

Member Function Documentation

◆ checkInput()

◆ checkOutput()

◆ execute()

◆ lastModified()

◆ lastModifiedChanged

◆ parentId()

◆ parentIdChanged

◆ setLastModified()

◆ setParentId()

◆ setType()

◆ successCallback()

◆ type()

◆ typeChanged