QPlaceContentRequest Class

The QPlaceContentRequest class represents the parameters of a content request. More...

Header:	#include <QPlaceContentRequest>
qmake:	QT += location
Since:	Qt 5.6

• List of all members, including inherited members

Public Functions

	QPlaceContentRequest()
	QPlaceContentRequest(const QPlaceContentRequest &other)
	~QPlaceContentRequest()
void	clear()
QVariant	contentContext() const
QPlaceContent::Type	contentType() const
int	limit() const
QString	placeId() const
void	setContentContext(const QVariant &context)
void	setContentType(QPlaceContent::Type type)
void	setLimit(int limit)
void	setPlaceId(const QString &identifier)
bool	operator!=(const QPlaceContentRequest &other) const
QPlaceContentRequest &	operator=(const QPlaceContentRequest &other)
bool	operator==(const QPlaceContentRequest &other) const

Detailed Description

The QPlaceContentRequest class represents the parameters of a content request.

The QPlaceContentRequest class is used in conjunction with a QPlaceManager to retrieve rich content like images and reviews in a paginated fashion. The following code would request a set of 5 images from the 10th index:

QPlaceContentRequest request;
request.setContentType(QPlaceContent::ImageType);
request.setPlaceId(place.placeId());
request.setLimit(5);

QPlaceContentReply *contentReply = manager->getPlaceContent(request);
//..connect signals..//
    ...
    ...
void contentHandler() {
    if (contentReply->error() == QPlaceReply::NoError)  {
        place.insertContent(contentReply->request().contentType(),
                            contentReply->content());
    }
}

See also QPlaceContentReply.

Member Function Documentation

QPlaceContentRequest::QPlaceContentRequest()

Constructs a new request object.

QPlaceContentRequest::QPlaceContentRequest(const QPlaceContentRequest &other)

Constructs a copy of other.

QPlaceContentRequest::~QPlaceContentRequest()

Destroys the request object

void QPlaceContentRequest::clear()

Clears the content request.

QVariant QPlaceContentRequest::contentContext() const

Returns backend specific additional content context associated with this place content request.

See also setContentContext().

QPlaceContent::Type QPlaceContentRequest::contentType() const

Returns the type of content to be requested, for example reviews or images

See also setContentType().

int QPlaceContentRequest::limit() const

Returns the maximum number of content items to retrieve.

A negative value for limit means that it is undefined. It is left up to the backend provider to choose an appropriate number of items to return.

The default limit is -1.

See also setLimit().

QString QPlaceContentRequest::placeId() const

Returns the identifier of the place content is to be fetched for.

See also setPlaceId().

void QPlaceContentRequest::setContentContext(const QVariant &context)

Sets the content context to context.

Note: This method is intended to be used by geo service plugins when returning place content results.

The content context is used by backends to store additional content context related to the content request. Other relevant fields should also be filled in. For example, if the content request is for image content the content type should also be set with setContentType(). The content context allows additional context to be kept which is not directly accessible via the Qt Location API.

The content context can be of any type storable in a QVariant. The value of the content context is not intended to be used directly by applications.

See also contentContext().

void QPlaceContentRequest::setContentType(QPlaceContent::Type type)

Sets the type of content to be requested.

See also contentType().

void QPlaceContentRequest::setLimit(int limit)

Set the maximum number of content items to retrieve to limit.

See also limit().

void QPlaceContentRequest::setPlaceId(const QString &identifier)

Sets the identifier of the place to fetch content for to identifier.

See also placeId().

bool QPlaceContentRequest::operator!=(const QPlaceContentRequest &other) const

Returns true if other is not equal to this content request, otherwise returns false.

QPlaceContentRequest &QPlaceContentRequest::operator=(const QPlaceContentRequest &other)

Assigns other to this content request and returns a reference to this content request.

bool QPlaceContentRequest::operator==(const QPlaceContentRequest &other) const

Returns true if other is equal to this content request, otherwise returns false.