Subgroup: Geo

Class: QgsGeoNodeRequest¶

class qgis.core.QgsGeoNodeRequest¶

Bases: PyQt5.QtCore.QObject

Request handler for GeoNode servers.

QgsGeoNodeRequest handles requesting and parsing service details from a GeoNode server instance, for instance requesting all available layers or layer styles.

New in version 3.0: Methods

`abort`	Aborts any active network request immediately.
`blockSignals`
`childEvent`
`children`
`connectNotify`
`customEvent`
`deleteLater`
`disconnect`
`disconnectNotify`
`dumpObjectInfo`
`dumpObjectTree`
`dynamicPropertyNames`
`event`
`eventFilter`
`fetchDefaultStyleBlocking`	Requests the default style for the layer with matching `layerName` from the server.
`fetchLayers`	Triggers a new request to fetch the list of available layers from the server.
`fetchLayersBlocking`	Requests the list of available layers from the server.
`fetchServiceUrlDataBlocking`	Obtains a map of layer name to URL for available services with matching `serviceType` from the server.
`fetchServiceUrlsBlocking`	Requests the list of unique URLs for available services with matching `serviceType` from the server.
`fetchStyleBlocking`	Requests the details for the style with matching `styleId` from the server.
`fetchStylesBlocking`	Requests the list of available styles for the layer with matching `layerName` from the server.
`findChild`	findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
`findChildren`	findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
`inherits`
`installEventFilter`
`isSignalConnected`
`isWidgetType`
`isWindowType`
`killTimer`
`lastError`	Returns the most recent error string for any encountered errors, or an empty string if no errors have been encountered.
`lastResponse`	Returns the most recent response obtained from the server.
`metaObject`
`moveToThread`
`objectName`
`parent`
`property`
`protocol`	Returns the network protocol (e.g.
`pyqtConfigure`	Each keyword argument is either the name of a Qt property or a Qt signal.
`receivers`
`removeEventFilter`
`request`	Triggers a new request to the GeoNode server, with the requested `endPoint`.
`requestBlocking`	Triggers a new request to the GeoNode server, with the requested `endPoint`.
`sender`
`senderSignalIndex`
`setObjectName`
`setParent`
`setProperty`
`setProtocol`	Sets the network `protocol` (e.g.
`signalsBlocked`
`startTimer`
`thread`
`timerEvent`
`tr`

Attributes

`destroyed`	destroyed(self, QObject = None) [signal]
`layersFetched`	Emitted when the result of a fetchLayers call has been received and processed.
`objectNameChanged`	objectNameChanged(self, str) [signal]
`requestFinished`	Emitted when the existing request has been completed.
`staticMetaObject`
`statusChanged`	Emitted when the status of an ongoing request is changed.

class ServiceLayerDetail¶

Bases: sip.wrapper

QgsGeoNodeRequest.ServiceLayerDetail(QgsGeoNodeRequest.ServiceLayerDetail)

name¶

title¶

typeName¶

uuid¶

wfsURL¶

wmsURL¶

xyzURL¶

abort(self)¶: Aborts any active network request immediately.

childEvent()¶

connectNotify()¶

customEvent()¶

disconnectNotify()¶

fetchDefaultStyleBlocking(self, layerName: str) → QgsGeoNodeStyle¶

Requests the default style for the layer with matching layerName from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

fetchLayers(self)¶

Triggers a new request to fetch the list of available layers from the server. When complete, the layersFetched() signal will be emitted with the result.

This method is non-blocking and returns immediately.

Warning

When using the non-blocking methods in this class, sending overlapping requests results in undefined behavior. Use separate instances of QgsGeoNodeRequest instead to avoid this.

See also

layersFetched()

See also

fetchLayersBlocking()

fetchLayersBlocking(self) → object¶

Requests the list of available layers from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

See also

fetchLayers()

fetchServiceUrlDataBlocking(self, serviceType: str) → Dict[str, str]¶

Obtains a map of layer name to URL for available services with matching serviceType from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

fetchServiceUrlsBlocking(self, serviceType: str) → List[str]¶

Requests the list of unique URLs for available services with matching serviceType from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

fetchStyleBlocking(self, styleId: str) → QgsGeoNodeStyle¶

Requests the details for the style with matching styleId from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

fetchStylesBlocking(self, layerName: str) → object¶

Requests the list of available styles for the layer with matching layerName from the server.

This method is blocking and will wait for results from the server before returning. Accordingly it should not be used from any code which potentially blocks operation in the main GUI thread.

isSignalConnected()¶

lastError(self) → str¶: Returns the most recent error string for any encountered errors, or an empty string if no errors have been encountered.

lastResponse(self) → QByteArray¶: Returns the most recent response obtained from the server.

layersFetched¶: Emitted when the result of a fetchLayers call has been received and processed. [signal]

protocol(self) → str¶: Returns the network protocol (e.g. ‘http’) used for connecting with the server.

See also

setProtocol()

receivers()¶

request(self, endPoint: str)¶

Triggers a new request to the GeoNode server, with the requested endPoint. Any existing request will be aborted.

Calling this method does not block while waiting for a result.

Warning

When using the non-blocking methods in this class, sending overlapping requests results in undefined behavior. Use separate instances of QgsGeoNodeRequest instead to avoid this.

See also

requestBlocking()

requestBlocking(self, endPoint: str) → bool¶

Triggers a new request to the GeoNode server, with the requested endPoint. Any existing request will be aborted.

Calling this method will block while waiting for a result. It should not be used from any code which potentially blocks operation in the main GUI thread.

See also

request()

requestFinished¶: Emitted when the existing request has been completed. [signal]

sender()¶

senderSignalIndex()¶

setProtocol(self, protocol: str)¶: Sets the network protocol (e.g. ‘http’) used for connecting with the server.

See also

protocol()

statusChanged¶: Emitted when the status of an ongoing request is changed. [signal]

timerEvent()¶