Class: QgsExternalStorage¶

Abstract interface for external storage - to be implemented by various backends and registered in QgsExternalStorageRegistry.

Added in version 3.22.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: displayName(), doFetch(), doStore(), type()

Abstract Methods

`displayName`	Returns the translated external storage name, which should be used for any user-visible display of the external storage name.
`doFetch`	Fetches file from url using authCfg for this project external storage.
`doStore`	Stores file filePath to the url using authCfg authentication for this project external storage.
`type`	Unique identifier of the external storage type.

Methods

`fetch`	Fetches file from url for this project external storage.
`store`	Stores file filePath to the url for this project external storage.

class qgis.core.QgsExternalStorage[source]¶

Bases: object

abstract displayName(self) → str[source]¶

Returns the translated external storage name, which should be used for any user-visible display of the external storage name.

Return type:: str

abstract doFetch(self, url: str | None, authCfg: str | None = '') → QgsExternalStorageFetchedContent | None[source]¶

Fetches file from url using authCfg for this project external storage.

See also

QgsExternalStorage.store()

Parameters:

filePath (Optional[str])
url (Optional[str])
authCfg (Optional[str] = '')

Return type:

Optional[QgsExternalStorageStoredContent]

fetch(self, url: str | None, authCfg: str | None = '', fetchingMode: Qgis.ActionStart = Qgis.ActionStart.Deferred) → QgsExternalStorageFetchedContent | None[source]¶

Fetches file from url for this project external storage. Fetching process is run in background. Returns a QgsExternalStorageFetchedContent to follow the status of the fetched resource.

fetchingMode defines if the download will start immediately or shall be manually triggered calling QgsExternalStorageFetchedContent.fetch(). User should use Qgis.ActionStart.Deferred if he needs to connect the fetched() signal.

After using this method, user should wait for QgsExternalStorageStoredContent.fetched(), QgsExternalStorageStoredContent.errorOccurred() or QgsExternalStorageStoredContent.canceled() signals.

It’s possible to give authCfg authentication configuration id in case its needed.

Parameters:

url (Optional[str])
authCfg (Optional[str] = '')
fetchingMode (Qgis.ActionStart = Qgis.ActionStart.Deferred)

Return type:

Optional[QgsExternalStorageFetchedContent]

store(self, filePath: str | None, url: str | None, authCfg: str | None = '', storingMode: Qgis.ActionStart = Qgis.ActionStart.Deferred) → QgsExternalStorageStoredContent | None[source]¶

Stores file filePath to the url for this project external storage. Storing process is run in background. Returns a QgsExternalStorageStoredContent to follow the status of the stored resource.

storingMode defines if the download will start immediately or shall be manually triggered calling QgsExternalStorageStoredContent.store(). User should use Qgis.ActionStart.Deferred if he needs to connect the stored() signal.

After using this method, user wait for QgsExternalStorageStoredContent.stored(), QgsExternalStorageStoredContent.errorOccurred() or QgsExternalStorageStoredContent.canceled() signals.

It’s possible to give authCfg authentication configuration id in case its needed.

Caller takes ownership of the returned symbol.

Parameters:

filePath (Optional[str])
url (Optional[str])
authCfg (Optional[str] = '')
storingMode (Qgis.ActionStart = Qgis.ActionStart.Deferred)

Return type:

Optional[QgsExternalStorageStoredContent]

abstract type(self) → str[source]¶

Unique identifier of the external storage type.

Return type:: str