QPlaceContentRequest

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

Inheritance diagram of PySide2.QtLocation.QPlaceContentRequest

Synopsis

Functions

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;
    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());
    }
}
class QPlaceContentRequest

QPlaceContentRequest(other)

param other

QPlaceContentRequest

Constructs a new request object.

Constructs a copy of other .

PySide2.QtLocation.QPlaceContentRequest.clear()

Clears the content request.

PySide2.QtLocation.QPlaceContentRequest.contentContext()
Return type

object

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

PySide2.QtLocation.QPlaceContentRequest.contentType()
Return type

Type

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

See also

setContentType()

PySide2.QtLocation.QPlaceContentRequest.limit()
Return type

int

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()

PySide2.QtLocation.QPlaceContentRequest.__ne__(other)
Parameters

otherQPlaceContentRequest

Return type

bool

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

PySide2.QtLocation.QPlaceContentRequest.__eq__(other)
Parameters

otherQPlaceContentRequest

Return type

bool

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

PySide2.QtLocation.QPlaceContentRequest.placeId()
Return type

unicode

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

See also

setPlaceId()

PySide2.QtLocation.QPlaceContentRequest.setContentContext(context)
Parameters

context – object

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()

PySide2.QtLocation.QPlaceContentRequest.setContentType(type)
Parameters

typeType

Sets the type of content to be requested.

See also

contentType()

PySide2.QtLocation.QPlaceContentRequest.setLimit(limit)
Parameters

limitint

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

See also

limit()

PySide2.QtLocation.QPlaceContentRequest.setPlaceId(identifier)
Parameters

identifier – unicode

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

See also

placeId()