Class ExternalStorage

Inherits the following classes: QObject

Public Properties

Type	Name
property QString	fetchedContent
property QString	lastError
property Qgis::ContentStatus	status
property QString	type

Public Signals

Type	Name
signal void	fetchedContentChanged
signal void	lastErrorChanged
signal void	statusChanged
signal void	typeChanged

Public Functions

Type	Name
	ExternalStorage (QObject * parent=nullptr)
Q_INVOKABLE void	fetch (const QString & url, const QString & authenticationConfigurationId)
QString	fetchedContent () const
QString	lastError () const
void	setType (const QString & type)
Qgis::ContentStatus	status () const
QString	type () const

Public Properties Documentation

property fetchedContent [1/2]

QString ExternalStorage::fetchedContent;

property lastError [1/2]

QString ExternalStorage::lastError;

property status [1/2]

Qgis::ContentStatus ExternalStorage::status;

property type [1/2]

QString ExternalStorage::type;

Public Signals Documentation

signal fetchedContentChanged

void ExternalStorage::fetchedContentChanged;

signal lastErrorChanged

void ExternalStorage::lastErrorChanged;

signal statusChanged

void ExternalStorage::statusChanged;

signal typeChanged

void ExternalStorage::typeChanged;

Public Functions Documentation

function ExternalStorage

explicit ExternalStorage::ExternalStorage (
    QObject * parent=nullptr
)

function fetch

Q_INVOKABLE void ExternalStorage::fetch (
    const QString & url,
    const QString & authenticationConfigurationId
)

Triggers a fetch operation to download the content from an external storage and make it available locally.

Parameters:

url the remote URL of the content
authenticationConfigurationId the authentication configuration ID used to connect to the external storage endpoint

function fetchedContent [2/2]

QString ExternalStorage::fetchedContent () const

Returns the file path of a successfully fetched content operation.

function lastError [2/2]

QString ExternalStorage::lastError () const

Returns the last error emitted by an external storage operation.

function setType

void ExternalStorage::setType (
    const QString & type
)

Sets the current external storage type string. The type string must be tied to an external storage object that was added in the QgsApplication::externalStorageRegistry().

function status [2/2]

Qgis::ContentStatus ExternalStorage::status () const

Returns the current status of the external storage object. When a fetch operation has been triggered, the status will reflect the last fetched content operation.

function type [2/2]

QString ExternalStorage::type () const

Returns the current external storage type string.

The documentation for this class was generated from the following file src/core/externalstorage.h