QPlaceContentRequest Class

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

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

Public Functions

QPlaceContentRequest(const QPlaceContentRequest &other)
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)
QPlaceContentRequest &operator=(const QPlaceContentRequest &other)
bool operator!=(const QPlaceContentRequest &lhs, const QPlaceContentRequest &rhs)
bool operator==(const QPlaceContentRequest &lhs, const QPlaceContentRequest &rhs)

Detailed Description

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;

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

See also QPlaceContentReply.

Member Function Documentation


Constructs a new request object.

[noexcept] QPlaceContentRequest::QPlaceContentRequest(const QPlaceContentRequest &other)

Constructs a copy of other.

[noexcept] 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().

[noexcept] QPlaceContentRequest &QPlaceContentRequest::operator=(const QPlaceContentRequest &other)

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

Related Non-Members

[noexcept] bool operator!=(const QPlaceContentRequest &lhs, const QPlaceContentRequest &rhs)

Returns true if lhs is not equal to rhs, otherwise returns false.

[noexcept] bool operator==(const QPlaceContentRequest &lhs, const QPlaceContentRequest &rhs)

Returns true if lhs is equal to rhs, otherwise returns false.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.