Class: QgsServerCacheFilter¶
-
class
qgis.server.
QgsServerCacheFilter
(serverInterface: QgsServerInterface)¶ Bases:
sip.wrapper
Constructor
QgsServerInterface
passed to plugins constructors and must be passed toQgsServerCacheFilter
instances.QgsServerCacheFilter(
QgsServerCacheFilter
)Class defining cache interface for QGIS Server plugins.
New in version 3.4.
- Parameters
serverInterface –
-
deleteCachedDocument
(self, project: QgsProject, request: QgsServerRequest, key: str) → bool¶ Deletes the cached document
- Parameters
project (QgsProject) – the project used to generate the document to provide path
request (QgsServerRequest) – the request used to generate the document to provider parameters or data
key (str) – the key provided by the access control to identify different documents for the same request
- Return type
bool
- Returns
true if the document has been deleted
-
deleteCachedDocuments
(self, project: QgsProject) → bool¶ Deletes all cached documents for a QGIS project
- Parameters
project (QgsProject) – the project used to generate the documents to provide path
- Return type
bool
- Returns
true if the documents have been deleted
-
deleteCachedImage
(self, project: QgsProject, request: QgsServerRequest, key: str) → bool¶ Deletes the cached image
- Parameters
project (QgsProject) – the project used to generate the image to provide path
request (QgsServerRequest) – the request used to generate the image to provider parameters or data
key (str) – the key provided by the access control to identify different images for the same request
- Return type
bool
- Returns
true if the image has been deleted
-
deleteCachedImages
(self, project: QgsProject) → bool¶ Deletes all cached images for a QGIS project
- Parameters
project (QgsProject) – the project used to generate the images to provide path
- Return type
bool
- Returns
true if the images have been deleted
-
getCachedDocument
(self, project: QgsProject, request: QgsServerRequest, key: str) → QByteArray¶ Returns cached document (or 0 if document not in cache) like capabilities
- Parameters
project (QgsProject) – the project used to generate the document to provide path
request (QgsServerRequest) – the request used to generate the document to provider parameters or data
key (str) – the key provided by the access control to identify different documents for the same request
- Return type
QByteArray
- Returns
QByteArray of the cached document or an empty one if no corresponding document found
-
getCachedImage
(self, project: QgsProject, request: QgsServerRequest, key: str) → QByteArray¶ Returns cached image (or 0 if document not in cache) like tiles
- Parameters
project (QgsProject) – the project used to generate the image to provide path
request (QgsServerRequest) – the request used to generate the image to provider parameters or data
key (str) – the key provided by the access control to identify different images for the same request
- Return type
QByteArray
- Returns
QByteArray of the cached image or an empty one if no corresponding image found
-
setCachedDocument
(self, doc: QDomDocument, project: QgsProject, request: QgsServerRequest, key: str) → bool¶ Updates or inserts the document in cache like capabilities
- Parameters
doc (QDomDocument) – the document to cache
project (QgsProject) – the project used to generate the document to provide path
request (QgsServerRequest) – the request used to generate the document to provider parameters or data
key (str) – the key provided by the access control to identify different documents for the same request
- Return type
bool
- Returns
true if the document has been cached
-
setCachedImage
(self, img: Union[QByteArray, bytes, bytearray], project: QgsProject, request: QgsServerRequest, key: str) → bool¶ Updates or inserts the image in cache like tiles
- Parameters
img (Union[QByteArray) – the document to cache
project (QgsProject) – the project used to generate the image to provide path
request (QgsServerRequest) – the request used to generate the image to provider parameters or data
key (str) – the key provided by the access control to identify different images for the same request
- Return type
bool
- Returns
true if the image has been cached