de::skycoder42::QtRestClient::RestClass Class Reference

The QML version of QtRestClient::RestClass. More...

#include <qmlrestclass.h>

Inheritance diagram for de::skycoder42::QtRestClient::RestClass:

Signals
void	restClassChanged (QtRestClient::RestClass *restClass)
	NOTIFY accessor for RestClass::restClass.
void	pathChanged (QString path)
	NOTIFY accessor for RestClass::path.

Public Member Functions
	QmlRestClass (QObject *parent=nullptr)
	Default constructor with object parent.
Q_INVOKABLE QtRestClient::QmlRestReply *	call (const QString &verb, QJSValue optPath={}, QJSValue optBody={}, QJSValue optParams={}, QJSValue optAsPost={}, QJSValue optHeaders={})
	Perform a HTTP-Request call on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	get (QJSValue optPath={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-GET-Request on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	post (QJSValue optPath={}, QJSValue optBodyParams={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-POST-Request on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	put (QJSValue optPathOrBody, QJSValue body={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-PUT-Request on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	deleteResource (QJSValue optPath={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-DELETE-Request on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	patch (QJSValue optPathOrBody, QJSValue body={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-PATCH-Request on this class. More...
Q_INVOKABLE QtRestClient::QmlRestReply *	head (QJSValue optPath={}, QJSValue optParams={}, QJSValue optHeaders={})
	Perform a HTTP-HEAD-Request on this class. More...

Properties
QtRestClient::RestClass	restClass
	The QtRestClient::RestClass made available via the QML variant. More...
QString	path
	The subpath to the parent class/api this class adds. More...
QQmlListProperty< de::skycoder42::QtRestClient::RestClass >	classes
	A helper property to declare RestClasses for the class as subclasses. More...

Detailed Description

The QML version of QtRestClient::RestClass.

Since

2.0

Definition at line 22 of file qmlrestclass.h.

Member Function Documentation

call()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::call	(	const QString &	verb,
		QJSValue	optPath = {},
		QJSValue	optBody = {},
		QJSValue	optParams = {},
		QJSValue	optAsPost = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-Request call on this class.

Parameters

verb	The HTTP-Verb to be used
optPath	Optional and variable parameter
optBody	Optional and variable parameter
optParams	Optional and variable parameter
optAsPost	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

verb [,path:string] [,body:object|array] [,params:object [,asPost:bool] [,headers:object]]

See also

QtRestClient::RestClass::call

deleteResource()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::deleteResource	(	QJSValue	optPath = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-DELETE-Request on this class.

Parameters

optPath	Optional and variable parameter
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string] [,params:object [,headers:object]]

See also

QtRestClient::RestClass::deleteResource

get()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::get	(	QJSValue	optPath = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-GET-Request on this class.

Parameters

optPath	Optional and variable parameter
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string,] [params:object [,headers:object]]

See also

QtRestClient::RestClass::get

head()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::head	(	QJSValue	optPath = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-HEAD-Request on this class.

Parameters

optPath	Optional and variable parameter
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string] [,params:object [,headers:object]]

See also

QtRestClient::RestClass::head

patch()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::patch	(	QJSValue	optPathOrBody,
		QJSValue	body = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-PATCH-Request on this class.

Parameters

optPathOrBody	Optional and variable parameter
body	The data body of the HTTP-Request, sent as json (can be object or array)
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string,] body:object|array [,params:object [,headers:object]]

See also

QtRestClient::RestClass::patch

post()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::post	(	QJSValue	optPath = {},
		QJSValue	optBodyParams = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-POST-Request on this class.

Parameters

optPath	Optional and variable parameter
optBodyParams	Optional and variable parameter
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string] [,body:object|array [,params:object [,headers:object]]]

See also

QtRestClient::RestClass::post

put()

Q_INVOKABLE QtRestClient::QmlRestReply* de::skycoder42::QtRestClient::RestClass::put	(	QJSValue	optPathOrBody,
		QJSValue	body = {},
		QJSValue	optParams = {},
		QJSValue	optHeaders = {}
	)

Perform a HTTP-PUT-Request on this class.

Parameters

optPathOrBody	Optional and variable parameter
body	The data body of the HTTP-Request, sent as json (can be object or array)
optParams	Optional and variable parameter
optHeaders	Optional and variable parameter

The method parameters are declared as var to be able to provide advance syntax. They are all placeholders for different types and can be used with the following syntax. They can be explicitly skipped by using undefined as value. (the format is <name>:<type>[|<type>...] for every possible param):

[path:string,] body:object|array [,params:object [,headers:object]]

See also

QtRestClient::RestClass::put

Property Documentation

classes

QQmlListProperty<de::skycoder42::QtRestClient::RestClass> de::skycoder42::QtRestClient::RestClass::classes

read

A helper property to declare RestClasses for the class as subclasses.

Default: empty

Accessors
MEMBER	classes

Definition at line 60 of file qmlrestclass.h.

path

QString de::skycoder42::QtRestClient::RestClass::path

readwrite

The subpath to the parent class/api this class adds.

Default: empty

Accessors
MEMBER	path
NOTIFY	pathChanged()

Definition at line 51 of file qmlrestclass.h.

restClass

QtRestClient::RestClass de::skycoder42::QtRestClient::RestClass::restClass

read

The QtRestClient::RestClass made available via the QML variant.

Default: auto

Accessors
MEMBER	restClass
MEMBER	restClassChanged

See also

QtRestClient::RestClass

Definition at line 42 of file qmlrestclass.h.

---

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

• qmlrestclass.h