Fuoten::CreateFolder Class Reference

Creates a new folder on the News App server. More...

#include <Fuoten/API/CreateFolder>

Inheritance diagram for Fuoten::CreateFolder:

Properties
QString	name
	The name for the new folder.
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
	CreateFolder (QObject *parent=nullptr)
	Constructs an API request object with the given parent to create a new folder on the remote server.
	~CreateFolder () override
	Destroys the CreateFolder object.
Q_INVOKABLE void	execute () override
	Executes the API request.
QString	name () const
	Returns the name of the folder to create.
void	setName (const QString &nName)
	Sets the name of the folder to create.
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	nameChanged (const QString &name)
	This signal is emitted when the name of the folder to create 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 name property.
bool	checkOutput () override
	Checks for a non-empty folders array in the replied JSON object.
void	extractError (QNetworkReply *reply) override
	Extracts possible errors replied by the News App API.
void	successCallback () override
	Finishes the folder creation 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.
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

Creates a new folder on the News App server.

To create a new folder, set the CreateFolder::name property to a valid string and set the Component::configuration to a valid object. Optionally set the Component::storage property to save the newly created folder in a local storage. 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::folderCreated() will be called in the successCallback() to save the new folder in the local storage. If the request succeeded, the Component::succeeded() signal will be emitted, containing the JSON API reply. If something failed, the Component::failed() signal will be emitted and Component::error will contain a valid pointer to an Error object.

Mandatory properties

CreateFolder::name, Component::configuration

API route

/folders

Method

POST

Property Documentation

name

QString Fuoten::CreateFolder::name

readwrite

The name for the new folder.

When setting this property, the input string will be simplified. See QString::simplified().

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

Access functions:

QString	name() const
void	setName(const QString &nName)

Notifier signal:

void	nameChanged(const QString &name)

Constructor & Destructor Documentation

CreateFolder()

CreateFolder::CreateFolder ( QObject * parent = nullptr )

explicit

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

~CreateFolder()

CreateFolder::~CreateFolder ( )

override

Destroys the CreateFolder object.

Member Function Documentation

checkInput()

bool CreateFolder::checkInput ( )

overrideprotectedvirtual

Checks for valid name property.

Will at first perform the checks of Component::checkInput(). Returns true if the checks pass, otherwise false.

Reimplemented from Fuoten::Component.

checkOutput()

bool CreateFolder::checkOutput ( )

overrideprotectedvirtual

Checks for a non-empty folders array in the replied JSON object.

Will at first perform the checks fo Component::checkOutput(). Returns true if the checks pass, otherwise false.

Reimplemented from Fuoten::Component.

execute()

void CreateFolder::execute ( )

overridevirtual

Executes the API request.

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

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.

extractError()

void CreateFolder::extractError ( QNetworkReply * reply )

overrideprotectedvirtual

Extracts possible errors replied by the News App API.

Reimplemented from Fuoten::Component.

name()

QString CreateFolder::name

(

)

const

Returns the name of the folder to create.

See also

name

nameChanged

void Fuoten::CreateFolder::nameChanged ( const QString & name )

signal

This signal is emitted when the name of the folder to create changes.

See also

name

setName()

void CreateFolder::setName

(

const QString &

nName

)

Sets the name of the folder to create.

See also

name

successCallback()

void CreateFolder::successCallback ( )

overrideprotectedvirtual

Finishes the folder creation if the request was successful.

If Component::storage points to a valid object, it will use AbstractStorage::folderCreated() to store the created folder. Afterwards it will set Component::inOperation to false and will emit the Component::succeeded() signal.

Implements Fuoten::Component.

---

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

• Fuoten/API/createfolder.h
• build/Fuoten/FuotenQt5_autogen/include/moc_createfolder.cpp
• Fuoten/API/createfolder.cpp