Subgroup: File

Class: QgsFileDownloader¶

class qgis.core.QgsFileDownloader¶

Bases: PyQt5.QtCore.QObject

QgsFileDownloader is a utility class for downloading files.

To use this class, it is necessary to pass the URL and an output file name as arguments to the constructor, the download will start immediately.

The download is asynchronous.

The object will destroy itself when the request completes, errors or is canceled. An optional authentication configuration can be specified.

Note

This class was part of the GUI library from QGIS 2.18.1 until QGIS 3.0

New in version 3.0: Methods

`blockSignals`
`cancelDownload`	Call to abort the download and delete this object after the cancelation has been processed.
`childEvent`
`children`
`connectNotify`
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProperty`
`signalsBlocked`
`startDownload`	Called to start the download
`startTimer`
`thread`
`timerEvent`
`tr`

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`downloadCanceled`	Emitted when the download was canceled by the user.
`downloadCompleted`	Emitted when the download has completed successfully [signal]
`downloadError`	Emitted when an error makes the download fail [signal]
`downloadExited`	Emitted always when the downloader exits [signal]
`downloadProgress`	Emitted when data are ready to be processed [signal]
`objectNameChanged`	objectNameChanged(self, str) [signal]
`staticMetaObject`

cancelDownload(self)¶: Call to abort the download and delete this object after the cancelation has been processed.

See also

downloadCanceled()

downloadCanceled¶: Emitted when the download was canceled by the user.

See also

cancelDownload() [signal]

downloadCompleted¶: Emitted when the download has completed successfully [signal]