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

#include <qmlpaging.h>

Public Slots
void	iterate (const QJSValue &iterator, int to=-1, int from=0)

void	iterate (const QJSValue &iterator, const QJSValue &failureHandler, const QJSValue &errorHandler, int to=-1, int from=0)

Public Member Functions
Q_INVOKABLE QtRestClient::RestReply *	next ()
	Performs a request for the next paging object. More...

Q_INVOKABLE QtRestClient::RestReply *	previous ()
	Performs a request for the previous paging object. More...

Properties
bool	valid

QVariantList	items
	Returns the items of this paging object, i.e. it's data. More...

int	total
	Returns the total number of objects there are. More...

int	offset
	Returns the offset this paging begins at. More...

bool	hasNext
	Returns true, if there is a next paging object. More...

QUrl	nextUrl
	Returns the link to the next paging object. More...

bool	hasPrevious
	Returns true, if there is a previous paging object. More...

QUrl	previousUrl
	Returns the link to the previous paging object. More...

QVariantMap	properties
	Returns a hash containing all properties of the original JSON. More...

Detailed Description

The QML version of QtRestClient::Paging.

Since: 2.0

Definition at line 18 of file qmlpaging.h.

Member Function Documentation

◆ iterate [1/2]

void de::skycoder42::QtRestClient::Paging::iterate	(	const QJSValue &	iterator,
		const QJSValue &	failureHandler,
		const QJSValue &	errorHandler,
		int	to = `-1`,
		int	from = `0`
	)

slot

Iterates over all paging objects

Parameters

iterator	The iterator to be be called for every element iterated over
failureHandler	Will be passed to GenericRestReply::onFailed for all replies
errorHandler	Will be passed to GenericRestReply::onError for all replies
to	The upper limit of how far the iteration should go (-1 means no limit)
from	The lower limit from where the iteration should start

See also: QtRestClient::Paging::iterate

◆ iterate [2/2]

void de::skycoder42::QtRestClient::Paging::iterate	(	const QJSValue &	iterator,
		int	to = `-1`,
		int	from = `0`
	)

slot

Iterates over all paging objects

Parameters

iterator	The iterator to be be called for every element iterated over
to	The upper limit of how far the iteration should go (-1 means no limit)
from	The lower limit from where the iteration should start

See also: QtRestClient::Paging::iterate

◆ next()

QtRestClient::Paging< T >::next ( )

Performs a request for the next paging object.

Returns: A generic reply, for the sent request, or nullptr, if no next element exists

The returned reply is owned by the caller. You can use it just like any other normal reply, created by a RestClass

◆ previous()

QtRestClient::Paging< T >::previous ( )

Performs a request for the previous paging object.

Returns: A generic reply, for the sent request, or nullptr, if no previous element exists

The returned reply is owned by the caller. You can use it just like any other normal reply, created by a RestClass

Property Documentation

◆ hasNext

bool de::skycoder42::QtRestClient::Paging::hasNext

read

Returns true, if there is a next paging object.

Default: false

Accessors
MEMBER	hasNext
READ ONLY

See also: QtRestClient::IPaging::hasNext

Definition at line 75 of file qmlpaging.h.

◆ hasPrevious

bool de::skycoder42::QtRestClient::Paging::hasPrevious

read

Returns true, if there is a previous paging object.

Default: false

Accessors
MEMBER	hasPrevious
READ ONLY

See also: QtRestClient::IPaging::hasPrevious

Definition at line 95 of file qmlpaging.h.

◆ items

QVariantList de::skycoder42::QtRestClient::Paging::items

read

Returns the items of this paging object, i.e. it's data.

Default: empty

Accessors
MEMBER	items
READ ONLY

See also: QtRestClient::IPaging::items

Definition at line 45 of file qmlpaging.h.

◆ nextUrl

QUrl de::skycoder42::QtRestClient::Paging::nextUrl

read

Returns the link to the next paging object.

Default: invalid

Accessors
MEMBER	nextUrl
READ ONLY

See also: QtRestClient::IPaging::next

Definition at line 85 of file qmlpaging.h.

◆ offset

int de::skycoder42::QtRestClient::Paging::offset

read

Returns the offset this paging begins at.

Default: -1

Accessors
MEMBER	offset
READ ONLY

See also: QtRestClient::IPaging::offset

Definition at line 65 of file qmlpaging.h.

◆ previousUrl

QUrl de::skycoder42::QtRestClient::Paging::previousUrl

read

Returns the link to the previous paging object.

Default: invalid

Accessors
MEMBER	previousUrl
READ ONLY

See also: QtRestClient::IPaging::previous

Definition at line 105 of file qmlpaging.h.

◆ properties

QVariantMap de::skycoder42::QtRestClient::Paging::properties

read

Returns a hash containing all properties of the original JSON.

Default: empty

Accessors
MEMBER	properties
READ ONLY

See also: QtRestClient::IPaging::properties

Definition at line 115 of file qmlpaging.h.

◆ total

int de::skycoder42::QtRestClient::Paging::total

read

Returns the total number of objects there are.

Default: INT_MAX

Accessors
MEMBER	total
READ ONLY

See also: QtRestClient::IPaging::total

Definition at line 55 of file qmlpaging.h.

◆ valid

bool de::skycoder42::QtRestClient::Paging::valid

read

Specifies, whether the paging object is valid and accessable

Default: false

Accessors
MEMBER	valid
READ ONLY

Definition at line 35 of file qmlpaging.h.

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

qmlpaging.h
paging.dox

Public Slots

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ iterate [1/2]

◆ iterate [2/2]

◆ next()

◆ previous()

Property Documentation

◆ hasNext

◆ hasPrevious

◆ items

◆ nextUrl

◆ offset

◆ previousUrl

◆ properties

◆ total

◆ valid