Class: QgsExternalStorageContent

Base class for QgsExternalStorage stored and fetched content.

Added in version 3.22.

Class Hierarchy

Base classes

QObject

Subclasses

QgsExternalStorageFetchedContent	Abstract base class for QgsExternalStorage fetched content.
QgsExternalStorageStoredContent	Abstract base class for QgsExternalStorage stored content.

class qgis.core.QgsExternalStorageContent

Bases: QObject

virtual cancel(self)

Cancels content fetching/storing

signal canceled

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

signal errorOccurred

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

errorString(self) → str

Returns error textual description if an error occurred and status() returns Failed

Return type:

str

signal progressChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

reportError(self, errorMsg: str | None)

Update content according to given errorMsg error message Inherited classes should call this method whenever they meet an error.

Parameters:

errorMsg (Optional[str])

setStatus(self, status: Qgis.ContentStatus)

Sets the external storage status

Parameters:

status (Qgis.ContentStatus)

status(self) → Qgis.ContentStatus

Returns content status

Return type:

Qgis.ContentStatus