QgsNetworkContentFetcherRegistry Class Reference

Registry for temporary fetched files. More...

#include <qgsnetworkcontentfetcherregistry.h>

Inheritance diagram for QgsNetworkContentFetcherRegistry:

Public Types
enum	FetchingMode { DownloadLater, DownloadImmediately }
	Enum to determine when the download should start. More...

Public Member Functions
	QgsNetworkContentFetcherRegistry ()=default
	Create the registry for temporary downloaded files. More...
	~QgsNetworkContentFetcherRegistry () override
const QgsFetchedContent *	fetch (const QString &url, FetchingMode fetchingMode=DownloadLater)
	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 123 of file qgsnetworkcontentfetcherregistry.h.

Member Enumeration Documentation

FetchingMode

enum QgsNetworkContentFetcherRegistry::FetchingMode

Enum to determine when the download should start.

Enumerator
DownloadLater	Do not start immediately the download to properly connect the fetched signal.
DownloadImmediately	The download will start immediately, not need to run QgsFecthedContent::download()

Definition at line 128 of file qgsnetworkcontentfetcherregistry.h.

Constructor & Destructor Documentation

QgsNetworkContentFetcherRegistry()

QgsNetworkContentFetcherRegistry::QgsNetworkContentFetcherRegistry ( )

explicitdefault

Create the registry for temporary downloaded files.

~QgsNetworkContentFetcherRegistry()

QgsNetworkContentFetcherRegistry::~QgsNetworkContentFetcherRegistry ( )

override

Definition at line 23 of file qgsnetworkcontentfetcherregistry.cpp.

Member Function Documentation

fetch()

const QgsFetchedContent * QgsNetworkContentFetcherRegistry::fetch	(	const QString &	url,
		FetchingMode	fetchingMode = DownloadLater
	)

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

Note

If the download starts immediately, it will not redownload any already fetched or currently fetching file.

Definition at line 33 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 52 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 83 of file qgsnetworkcontentfetcherregistry.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.14.0+99unstable/src/core/qgsnetworkcontentfetcherregistry.h
• /build/qgis-3.14.0+99unstable/src/core/qgsnetworkcontentfetcherregistry.cpp