QGIS API Documentation 3.41.0-Master (181b2f43d8e)
|
Utility functions for working with ArcGIS REST services. More...
#include <qgsarcgisportalutils.h>
Static Public Member Functions | |
static QVariantList | retrieveGroupContent (const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, int pageSize=100, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all items which belong the the specified groupId. | |
static Q_DECL_DEPRECATED QVariantList | retrieveGroupContent (const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle, QString &errorText, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback=nullptr, int pageSize=100, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all items which belong the the specified groupId. | |
static QVariantList | retrieveGroupItemsOfType (const QString &contentUrl, const QString &groupId, const QString &authcfg, const QList< int > &itemTypes, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, int pageSize=100, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all items which belong the the specified groupId. | |
static Q_DECL_DEPRECATED QVariantList | retrieveGroupItemsOfType (const QString &contentUrl, const QString &groupId, const QString &authcfg, const QList< int > &itemTypes, QString &errorTitle, QString &errorText, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback=nullptr, int pageSize=100, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all items which belong the the specified groupId. | |
static QVariantList | retrieveUserGroups (const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all groups which the specified user name is a member of. | |
static Q_DECL_DEPRECATED QVariantList | retrieveUserGroups (const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle, QString &errorText, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString()) |
Retrieves JSON definitions for all groups which the specified user name is a member of. | |
static QVariantMap | retrieveUserInfo (const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle, QString &errorText, const QgsHttpHeaders &requestHeaders=QgsHttpHeaders(), QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString()) |
Retrieves JSON user info for the specified user name. | |
static Q_DECL_DEPRECATED QVariantMap | retrieveUserInfo (const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle, QString &errorText, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback=nullptr, const QString &urlPrefix=QString()) |
Retrieves JSON user info for the specified user name. | |
Utility functions for working with ArcGIS REST services.
Definition at line 37 of file qgsarcgisportalutils.h.
|
static |
Retrieves JSON definitions for all items which belong the the specified groupId.
contentUrl | should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content/ |
groupId | ID of group to query |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
pageSize | number of results to retrieve for each request. Maximum value is 100. |
urlPrefix | http web proxy url prefix |
Definition at line 57 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON definitions for all items which belong the the specified groupId.
Only to avoid API break.
contentUrl | should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content/ |
groupId | ID of group to query |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
pageSize | number of results to retrieve for each request. Maximum value is 100. |
urlPrefix | http web proxy url prefix |
Definition at line 94 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON definitions for all items which belong the the specified groupId.
contentUrl | should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content/ |
groupId | ID of group to query |
authcfg | authentication configuration ID |
itemTypes | list of desired item types (using Qgis.ArcGisRestServiceType values) |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
pageSize | number of results to retrieve for each request. Maximum value is 100. |
urlPrefix | http web proxy url prefix |
Definition at line 99 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON definitions for all items which belong the the specified groupId.
Only to avoid API break.
contentUrl | should be set to the Portal's content URL, e.g. https://mysite.com/portal/sharing/rest/content/ |
groupId | ID of group to query |
authcfg | authentication configuration ID |
itemTypes | list of desired item types (using Qgis.ArcGisRestServiceType values) |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
pageSize | number of results to retrieve for each request. Maximum value is 100. |
urlPrefix | http web proxy url prefix |
Definition at line 122 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON definitions for all groups which the specified user name is a member of.
If user is blank then the user associated with the current logon details will be retrieved
communityUrl | should be set to the Portal's community URL, e.g. https://mysite.com/portal/sharing/rest/community/ |
user | username to query, or an empty string to query the current user |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
urlPrefix | http web proxy url prefix |
Definition at line 46 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON definitions for all groups which the specified user name is a member of.
Only to avoid API break.
If user is blank then the user associated with the current logon details will be retrieved
communityUrl | should be set to the Portal's community URL, e.g. https://mysite.com/portal/sharing/rest/community/ |
user | username to query, or an empty string to query the current user |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
urlPrefix | http web proxy url prefix |
Definition at line 52 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON user info for the specified user name.
If user is blank then the user associated with the current logon details will be retrieved
communityUrl | should be set to the Portal's community URL, e.g. https://mysite.com/portal/sharing/rest/community/ |
user | username to query, or an empty string to query the current user |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
urlPrefix | http web proxy url prefix |
Definition at line 22 of file qgsarcgisportalutils.cpp.
|
static |
Retrieves JSON user info for the specified user name.
Only to avoid API break.
If user is blank then the user associated with the current logon details will be retrieved
communityUrl | should be set to the Portal's community URL, e.g. https://mysite.com/portal/sharing/rest/community/ |
user | username to query, or an empty string to query the current user |
authcfg | authentication configuration ID |
errorTitle | title summary of any encountered errors |
errorText | error text of any encountered errors |
requestHeaders | optional additional request headers |
feedback | optional feedback argument for cancellation support |
urlPrefix | http web proxy url prefix |
Definition at line 41 of file qgsarcgisportalutils.cpp.