DeleteFolder Class Reference

#include <deletefolder.h>

Inheritance diagram for DeleteFolder:

Properties
qint64	folderId
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
	DeleteFolder (QObject *parent=nullptr)
	~DeleteFolder () override
Q_INVOKABLE void	execute () override
qint64	folderId () const
void	setFolderId (qint64 nFolderId)
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	folderIdChanged (qint64 folderId)
void	succeeded (qint64 id)
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 (AbstractNotificator::Type type, QtMsgType severity, const QVariant &data) const
void	notify (const Error *e) 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

Deletes a folder on the News App server.

To delete a folder on the server, set DeleteFolder::folderId to a valid ID and set a AbstractConfiguration to Component::configuration.

If a valid AbstractStorage object is set to the Component::storage property, AbstractStorage::folderDeleted() will be called in the successCallback() to delete the folder in the local storage. If the request succeeded, the succeed() signal will be emitted in the successCallback() and it will contain the id of the deleted folder. If the request failed, Component::faild() will be emitted and Component::error contains a valid pointer to an Error object.

Mandatory properties

DeleteFolder::folderId, Component::configuration

API route

/folders/{folderId}

Method

DELETE

Property Documentation

folderId

qint64 folderId

readwrite

ID of the folder to delete.

Has to be set to a valid folder ID. This property can not be changed while Component::inOperation() returns true.

Access functions:

qint64	folderId() const
void	setFolderId(qint64 nFolderId)

Notifier signal:

void	folderIdChanged(qint64 folderId)

Constructor & Destructor Documentation

DeleteFolder()

DeleteFolder ( QObject * parent = nullptr )

explicit

Constructs an API request object with the given parent to delete a folder on the remote server.

~DeleteFolder()

~DeleteFolder ( )

override

Destroys the DeleteFolder object.

Member Function Documentation

checkInput()

bool checkInput ( )

overrideprotectedvirtual

Checks for a valid folder ID.

This will at first perform the checks of Component::checkInput() and will than simply check if the folder id is greater than zero.

Reimplemented from Component.

execute()

void execute ( )

overridevirtual

Executes the API request.

To perform a successful API request to delete a folder, DeleteFolder::folderId has to be a valid folder ID and there has to be a 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.

This function is invokable from QML.

Implements Component.

extractError()

void extractError ( QNetworkReply * reply )

overrideprotectedvirtual

Extracts possible errors replied by the News App API.

Reimplemented from Component.

folderId()

qint64 folderId

(

)

const

Returns the ID of the folder to delete.

See also

folderId

folderIdChanged

void folderIdChanged ( qint64 folderId )

signal

This signal is emitted when the ID of the folder to delete changes.

See also

folderId

setFolderId()

void setFolderId

(

qint64

nFolderId

)

Sets the ID of the folder to delete.

See also

folderId

succeeded

void succeeded ( qint64 id )

signal

Will be emitted in the success callback function and contains the ID of the deleted folder.

See also

Component::failed()

successCallback()

void successCallback ( )

overrideprotectedvirtual

Finishes the folder deletion if the request was successful.

Implements Component.