Class: QgsFetchedContent

Holds information about fetched network content.

See also

QgsNetworkContentFetcherRegistry

Added in version 3.2.

Class Hierarchy

Inheritance diagram of qgis.core.QgsFetchedContent

Base classes

QObject
class qgis.core.QgsFetchedContent[source]

Bases: QObject

__init__(url: str | None, file: QTemporaryFile | None = None, status: QgsFetchedContent.ContentStatus = QgsFetchedContent.NotStarted, authConfig: str | None = '')

Constructs a FetchedContent with pointer to the downloaded file and status of the download

Parameters:

  • url (Optional[str])

  • file (Optional[QTemporaryFile] = None)

  • status (QgsFetchedContent.ContentStatus = QgsFetchedContent.NotStarted)

  • authConfig (Optional[str] = '')

class ContentStatus

Bases: int

Downloading = 1
Failed = 3
Finished = 2
NotStarted = 0
authConfig(self) → str[source]

Returns the authentication configuration id use for this fetched content

Return type:

str

cancel(self)[source]

Cancel the download operation.

download(self, redownload: bool = False)[source]

Start the download

Parameters:

redownload (bool = False) – if set to True, it will restart any achieved or pending download.

error(self) → QNetworkReply.NetworkError[source]

Returns the potential error of the download

Return type:

QNetworkReply.NetworkError

signal errorOccurred[source]

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 fetched[source]

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.

filePath(self) → str[source]

Returns the path to the local file, an empty string if the file is not accessible yet.

Return type:

str

status(self) → QgsFetchedContent.ContentStatus[source]

Returns the status of the download

Return type:

QgsFetchedContent.ContentStatus