Utility functions for querying ArcGIS REST services. More...

#include <qgsarcgisrestquery.h>

Public Types
enum class	ServiceTypeFilter { AllTypes , Vector , Raster }
	Service types. More...

Static Public Member Functions
static void	addLayerItems (const std::function< void(const QString &parentLayerId, ServiceTypeFilter serviceType, Qgis::GeometryType geometryType, const QString &layerId, const QString &name, const QString &description, const QString &url, bool isParentLayer, const QString &authid, const QString &format)> &visitor, const QVariantMap &serviceData, const QString &parentUrl, const QString &parentSupportedFormats, const ServiceTypeFilter filter=ServiceTypeFilter::AllTypes)
	Calls the specified visitor function on all layer items found within the given service data. More...

static QgsRectangle	getExtent (const QString &layerurl, const QString &whereClause, const QString &authcfg, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders())
	Retrieves the extent for the features matching a whereClause. More...

static QVariantMap	getLayerInfo (const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders())
	Retrieves JSON layer info for the specified layer URL. More...

static QVariantMap	getObjectIds (const QString &layerurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), const QgsRectangle &bbox=QgsRectangle(), const QString &whereClause=QString())
	Retrieves all object IDs for the specified layer URL. More...

static QList< quint32 >	getObjectIdsByExtent (const QString &layerurl, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QString &authcfg, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &whereClause=QString())
	Gets a list of object IDs which fall within the specified extent. More...

static QVariantMap	getObjects (const QString &layerurl, const QString &authcfg, const QList< quint32 > &objectIds, const QString &crs, bool fetchGeometry, const QStringList &fetchAttributes, bool fetchM, bool fetchZ, const QgsRectangle &filterRect, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr)
	Retrieves all matching objects from the specified layer URL. More...

static QVariantMap	getServiceInfo (const QString &baseurl, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders())
	Retrieves JSON service info for the specified base URL. More...

static QUrl	parseUrl (const QUrl &url, bool *isTestEndpoint=nullptr)
	Parses and processes a url. More...

static QByteArray	queryService (const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback feedback=nullptr, QString contentType=nullptr)
	Performs a blocking request to a URL and returns the retrieved data. More...

static QVariantMap	queryServiceJSON (const QUrl &url, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr)
	Performs a blocking request to a URL and returns the retrieved JSON content. More...

static void	visitFolderItems (const std::function< void(const QString &folderName, const QString &url)> &visitor, const QVariantMap &serviceData, const QString &baseUrl)
	Calls the specified visitor function on all folder items found within the given service data. More...

static void	visitServiceItems (const std::function< void(const QString &serviceName, const QString &url, Qgis::ArcGisRestServiceType serviceType)> &visitor, const QVariantMap &serviceData, const QString &baseUrl)
	Calls the specified visitor function on all service items found within the given service data. More...

Friends
class	TestQgsArcGisRestUtils

Detailed Description

Utility functions for querying ArcGIS REST services.

Since: QGIS 3.18

Definition at line 37 of file qgsarcgisrestquery.h.

Member Enumeration Documentation

◆ ServiceTypeFilter

enum class QgsArcGisRestQueryUtils::ServiceTypeFilter

strong

Service types.

Enumerator
AllTypes	All types.
Vector	Vector type.
Raster	Raster type.

Definition at line 44 of file qgsarcgisrestquery.h.

Member Function Documentation

◆ addLayerItems()

void QgsArcGisRestQueryUtils::addLayerItems	(	const std::function< void(const QString &parentLayerId, ServiceTypeFilter serviceType, Qgis::GeometryType geometryType, const QString &layerId, const QString &name, const QString &description, const QString &url, bool isParentLayer, const QString &authid, const QString &format)> &	visitor,
		const QVariantMap &	serviceData,
		const QString &	parentUrl,
		const QString &	parentSupportedFormats,
		const ServiceTypeFilter	filter = `ServiceTypeFilter::AllTypes`
	)

static

Calls the specified visitor function on all layer items found within the given service data.

Definition at line 377 of file qgsarcgisrestquery.cpp.

◆ getExtent()

QgsRectangle QgsArcGisRestQueryUtils::getExtent	(	const QString &	layerurl,
		const QString &	whereClause,
		const QString &	authcfg,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`
	)

static

Retrieves the extent for the features matching a whereClause.

Since: QGIS 3.28

Definition at line 72 of file qgsarcgisrestquery.cpp.

◆ getLayerInfo()

QVariantMap QgsArcGisRestQueryUtils::getLayerInfo	(	const QString &	layerurl,
		const QString &	authcfg,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`
	)

static

Retrieves JSON layer info for the specified layer URL.

Definition at line 42 of file qgsarcgisrestquery.cpp.

◆ getObjectIds()

QVariantMap QgsArcGisRestQueryUtils::getObjectIds	(	const QString &	layerurl,
		const QString &	authcfg,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`,
		const QgsRectangle &	bbox = `QgsRectangle()`,
		const QString &	whereClause = `QString()`
	)

static

Retrieves all object IDs for the specified layer URL.

Definition at line 52 of file qgsarcgisrestquery.cpp.

◆ getObjectIdsByExtent()

QList< quint32 > QgsArcGisRestQueryUtils::getObjectIdsByExtent	(	const QString &	layerurl,
		const QgsRectangle &	filterRect,
		QString &	errorTitle,
		QString &	errorText,
		const QString &	authcfg,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`,
		QgsFeedback *	feedback = `nullptr`,
		const QString &	whereClause = `QString()`
	)

static

Gets a list of object IDs which fall within the specified extent.

Definition at line 141 of file qgsarcgisrestquery.cpp.

◆ getObjects()

QVariantMap QgsArcGisRestQueryUtils::getObjects	(	const QString &	layerurl,
		const QString &	authcfg,
		const QList< quint32 > &	objectIds,
		const QString &	crs,
		bool	fetchGeometry,
		const QStringList &	fetchAttributes,
		bool	fetchM,
		bool	fetchZ,
		const QgsRectangle &	filterRect,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`,
		QgsFeedback *	feedback = `nullptr`
	)

static

Retrieves all matching objects from the specified layer URL.

Definition at line 99 of file qgsarcgisrestquery.cpp.

◆ getServiceInfo()

QVariantMap QgsArcGisRestQueryUtils::getServiceInfo	(	const QString &	baseurl,
		const QString &	authcfg,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`
	)

static

Retrieves JSON service info for the specified base URL.

Definition at line 32 of file qgsarcgisrestquery.cpp.

◆ parseUrl()

QUrl QgsArcGisRestQueryUtils::parseUrl	(	const QUrl &	url,
		bool *	isTestEndpoint = `nullptr`
	)

static

Parses and processes a url.

Definition at line 242 of file qgsarcgisrestquery.cpp.

◆ queryService()

QByteArray QgsArcGisRestQueryUtils::queryService	(	const QUrl &	url,
		const QString &	authcfg,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`,
		QgsFeedback *	feedback = `nullptr`,
		QString *	contentType = `nullptr`
	)

static

Performs a blocking request to a URL and returns the retrieved data.

Definition at line 171 of file qgsarcgisrestquery.cpp.

◆ queryServiceJSON()

QVariantMap QgsArcGisRestQueryUtils::queryServiceJSON	(	const QUrl &	url,
		const QString &	authcfg,
		QString &	errorTitle,
		QString &	errorText,
		const QgsHttpHeaders &	requestHeaders = `QgsHttpHeaders()`,
		QgsFeedback *	feedback = `nullptr`
	)

static

Performs a blocking request to a URL and returns the retrieved JSON content.

Definition at line 211 of file qgsarcgisrestquery.cpp.

◆ visitFolderItems()

void QgsArcGisRestQueryUtils::visitFolderItems	(	const std::function< void(const QString &folderName, const QString &url)> &	visitor,
		const QVariantMap &	serviceData,
		const QString &	baseUrl
	)

static

Calls the specified visitor function on all folder items found within the given service data.

Definition at line 316 of file qgsarcgisrestquery.cpp.

◆ visitServiceItems()

void QgsArcGisRestQueryUtils::visitServiceItems	(	const std::function< void(const QString &serviceName, const QString &url, Qgis::ArcGisRestServiceType serviceType)> &	visitor,
		const QVariantMap &	serviceData,
		const QString &	baseUrl
	)

static

Calls the specified visitor function on all service items found within the given service data.

Definition at line 335 of file qgsarcgisrestquery.cpp.

Friends And Related Function Documentation

◆ TestQgsArcGisRestUtils

friend class TestQgsArcGisRestUtils

friend

Definition at line 123 of file qgsarcgisrestquery.h.

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

/build/qgis-3.30.0+99sid/src/core/providers/arcgis/qgsarcgisrestquery.h
/build/qgis-3.30.0+99sid/src/core/providers/arcgis/qgsarcgisrestquery.cpp

Public Types

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ ServiceTypeFilter

Member Function Documentation

◆ addLayerItems()

◆ getExtent()

◆ getLayerInfo()

◆ getObjectIds()

◆ getObjectIdsByExtent()

◆ getObjects()

◆ getServiceInfo()

◆ parseUrl()

◆ queryService()

◆ queryServiceJSON()

◆ visitFolderItems()

◆ visitServiceItems()

Friends And Related Function Documentation

◆ TestQgsArcGisRestUtils