#include <Fuoten/API/PostWipeSuccess>

Inheritance diagram for PostWipeSuccess:

Public Member Functions
	PostWipeSuccess (QObject *parent=nullptr)
	~PostWipeSuccess () 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	checkInput () 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 ()
virtual void	extractError (QNetworkReply *reply)
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 }
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

Signals wipe completion to the Nextcloud server.

This posts the success message to the Nextcloud server after a requested remote wipe has been successfuly performed on the local device. Should be used after a remote wipe has been signaled by GetWipeStatus::wipeRequested() and the local wipe has been performed. There is already WipeManager that can handle remote wipe requests.

Mandatory properties: Component::configuration

API route: Not part of the News App API, uses general Nextcloud API at /index.php/core/wipe/success

Method: POST

Since: 0.8.0

See also: WipeManager, GetWipeStatus

Constructor & Destructor Documentation

◆ PostWipeSuccess()

PostWipeSuccess ( QObject * parent = nullptr )

explicit

Constructs a new PostWipeSuccess object with the given parent.

◆ ~PostWipeSuccess()

~PostWipeSuccess ( )

override

Destroys the PostWipeSuccess object.

Member Function Documentation

◆ checkInput()

bool checkInput ( )

overrideprotectedvirtual

Checks the input parameters.

Will especially check if the password has been set.

Reimplemented from Component.

◆ execute()

void execute ( )

overridevirtual

Executes the API request.

To perform a successful API request, the configuration property has to be set to a valid object derived from AbstractConfiguration.

Execution will not run if the inOperation property returns true and will itself set that property to true when starting the request.

Implements Component.

◆ successCallback()

void successCallback ( )