class QPlaceReply

The QPlaceReply class manages an operation started by an instance of QPlaceManager and serves as a base class for more specialized replies. More…

Inherited by: QPlaceSearchSuggestionReply, QPlaceSearchReply, QPlaceMatchReply, QPlaceIdReply, QPlaceDetailsReply, QPlaceContentReply

Synopsis

Methods

• def __init__()

• def error()

• def errorString()

• def isFinished()

• def setError()

• def setFinished()

Virtual methods

• def abort()

• def type()

Signals

• def aborted()

• def contentUpdated()

• def errorOccurred()

• def finished()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The QPlaceReply and each of its specialized subclasses manage the state and results of their corresponding operations. The QPlaceReply itself is used for operations that have no results, that is, it only necessary to know if the operation succeeded or failed.

The finished() signal can be used to monitor the progress of an operation. Once an operation is complete, the error() and errorString() methods provide information on whether the operation completed successfully. If successful, the reply will contain the results for that operation, that is, each subclass will have appropriate functions to retrieve the results of an operation.

See also

QPlaceManager

class Error

Describes an error which occurred during an operation.

Constant	Description
QPlaceReply.NoError	No error has occurred
QPlaceReply.PlaceDoesNotExistError	A specified place could not be found
QPlaceReply.CategoryDoesNotExistError	A specified category could not be found
QPlaceReply.CommunicationError	An error occurred communicating with the service provider.
QPlaceReply.ParseError	The response from the service provider or an import file was in an unrecognizable format
QPlaceReply.PermissionsError	The operation failed because of insufficient permissions.
QPlaceReply.UnsupportedError	The operation was not supported by the service provider.
QPlaceReply.BadArgumentError	. A parameter that was provided was invalid.
QPlaceReply.CancelError	The operation was canceled.
QPlaceReply.UnknownError	An error occurred which does not fit into any of the other categories.

class Type

Describes the reply’s type.

Constant	Description
QPlaceReply.Reply	This is a generic reply.
QPlaceReply.DetailsReply	This is a reply for the retrieval of place details
QPlaceReply.SearchReply	This is a reply for the place search operation.
QPlaceReply.SearchSuggestionReply	This is a reply for a search suggestion operation.
QPlaceReply.ContentReply	This is a reply for content associated with a place.
QPlaceReply.IdReply	This is a reply that returns an identifier of a place or category. Typically used for place or category save and remove operations.
QPlaceReply.MatchReply	This is a reply that returns places that match those from another provider.

__init__([parent=None])

Parameters:

parent – QObject

Constructs a reply object with a given parent.

abort()

Cancels the operation immediately.

See also

aborted()

aborted()

This signal is emitted when the operation has been cancelled.

See also

abort()

contentUpdated()

This signal is emitted when this reply has updated content available. Depending on the plugin, this signal may never be emitted or emitted multiple times before finished() is emitted, as some backends are able to return the requested content asynchronously and incrementally.

Note

Do not delete or deleteLater this reply object in the slot connected to this signal. Do it only upon finished .

error()

Return type:

Error

Returns the error code.

See also

setError()

errorOccurred(error[, errorString=""])

Parameters:

• error – Error

• errorString – str

This signal is emitted when an error has been detected in the processing of this reply. The finished() signal will probably follow.

The error will be described by the error code error. If errorString is not empty it will contain a textual description of the error meant for developers and not end users.

This signal and errorOccurred() will be emitted at the same time.

Note

Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

errorString()

Return type:

str

Returns the error string of the reply. The error string is intended to be used by developers only and is not fit to be displayed to an end user.

If no error has occurred, the string is empty.

finished()

This signal is emitted when this reply has finished processing.

If error() equals NoError then the processing finished successfully.

This signal and finished() will be emitted at the same time.

Note

Do not delete this reply object in the slot connected to this signal. Use deleteLater() instead.

See also

setFinished()

isFinished()

Return type:

bool

Return true if the reply has completed.

setError(error, errorString)

Parameters:

• error – Error

• errorString – str

Sets the error and errorString of the reply. This function does not cause the errorOccurred ( Error , const QString & errorString ) signal to be emitted.

See also

error()

setFinished(finished)

Parameters:

finished – bool

Sets the status of whether the reply is finished or not. This function does not cause the finished() signal to be emitted.

See also

finished()

type()

Return type:

Type

Returns the type of the reply.