Registry for temporary fetched files. More...
#include <qgsnetworkcontentfetcherregistry.h>
Public Member Functions | |
| QgsNetworkContentFetcherRegistry ()=default | |
| Create the registry for temporary downloaded files. More... | |
| ~QgsNetworkContentFetcherRegistry () override | |
| QgsFetchedContent * | fetch (const QString &url, Qgis::ActionStart fetchingMode=Qgis::ActionStart::Deferred, const QString &authConfig=QString()) |
| Initialize a download for the given URL. More... | |
| QFile * | localFile (const QString &filePathOrUrl) |
| Returns a QFile from a local file or to a temporary file previously fetched by the registry. More... | |
| QString | localPath (const QString &filePathOrUrl) |
| Returns the path to a local file or to a temporary file previously fetched by the registry. More... | |
Detailed Description
Registry for temporary fetched files.
This provides a simple way of downloading and accessing remote files during QGIS application running.
- See also
- QgsFetchedContent
- Since
- QGIS 3.2
Definition at line 139 of file qgsnetworkcontentfetcherregistry.h.
Constructor & Destructor Documentation
◆ QgsNetworkContentFetcherRegistry()
|
explicitdefault |
Create the registry for temporary downloaded files.
◆ ~QgsNetworkContentFetcherRegistry()
|
override |
Definition at line 26 of file qgsnetworkcontentfetcherregistry.cpp.
Member Function Documentation
◆ fetch()
| QgsFetchedContent * QgsNetworkContentFetcherRegistry::fetch | ( | const QString & | url, |
| Qgis::ActionStart | fetchingMode = Qgis::ActionStart::Deferred, |
||
| const QString & | authConfig = QString() |
||
| ) |
Initialize a download for the given URL.
- Parameters
-
url the URL to be fetched fetchingMode defines if the download will start immediately or shall be manually triggered authConfig authentication configuration id to be used while fetching
- Note
- If the download starts immediately, it will not redownload any already fetched or currently fetching file.
Definition at line 36 of file qgsnetworkcontentfetcherregistry.cpp.
◆ localFile()
| QFile * QgsNetworkContentFetcherRegistry::localFile | ( | const QString & | filePathOrUrl | ) |
Returns a QFile from a local file or to a temporary file previously fetched by the registry.
- Parameters
-
filePathOrUrl can either be a local file path or a remote content which has previously been fetched
Definition at line 55 of file qgsnetworkcontentfetcherregistry.cpp.
◆ localPath()
| QString QgsNetworkContentFetcherRegistry::localPath | ( | const QString & | filePathOrUrl | ) |
Returns the path to a local file or to a temporary file previously fetched by the registry.
- Parameters
-
filePathOrUrl can either be a local file path or a remote content which has previously been fetched
Definition at line 86 of file qgsnetworkcontentfetcherregistry.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.26.3+32focal/src/core/network/qgsnetworkcontentfetcherregistry.h
- /build/qgis-3.26.3+32focal/src/core/network/qgsnetworkcontentfetcherregistry.cpp
