Class: QgsFetchedContent

class qgis.core.QgsFetchedContent

Bases: PyQt5.QtCore.QObject

FetchedContent holds useful information about a network content being fetched

New in version 3.2.

QgsFetchedContent(url: str, file: QTemporaryFile = None, status: QgsFetchedContent.ContentStatus = QgsFetchedContent.NotStarted, authConfig: str = ‘’) Constructs a FetchedContent with pointer to the downloaded file and status of the download

Methods

authConfig

Returns the authentication configuration id use for this fetched content

cancel

Cancel the download operation.

childEvent

connectNotify

customEvent

disconnectNotify

download

Start the download

error

Returns the potential error of the download

filePath

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

isSignalConnected

receivers

sender

senderSignalIndex

status

Returns the status of the download

timerEvent

Signals

errorOccurred

Emitted when an error with code error occurred while processing the request errorMsg is a textual description of the error

fetched

Emitted when the file is fetched and accessible [signal]

Attributes

Downloading

Failed

Finished

NotStarted

class ContentStatus

Bases: int

Downloading = 1
Failed = 3
Finished = 2
NotStarted = 0
authConfig(self) str

Returns the authentication configuration id use for this fetched content

Return type

str

cancel(self)

Cancel the download operation.

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
download(self, redownload: bool = False)

Start the download

Parameters

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

error(self) QNetworkReply.NetworkError

Returns the potential error of the download

Return type

QNetworkReply.NetworkError

errorOccurred

Emitted when an error with code error occurred while processing the request errorMsg is a textual description of the error

New in version 3.22: [signal]

Parameters
  • code (QNetworkReply.NetworkError) –

  • errorMsg (str) –

fetched

Emitted when the file is fetched and accessible [signal]

filePath(self) str

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

Return type

str

isSignalConnected(self, QMetaMethod) bool
receivers(self, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
status(self) QgsFetchedContent.ContentStatus

Returns the status of the download

Return type

QgsFetchedContent.ContentStatus

timerEvent(self, QTimerEvent)