Skip to content

Commit

Permalink
ArcGIS URL's with web proxy prefix support
Browse files Browse the repository at this point in the history 
Support of the ArcGIS server links with WEB Proxy prefixes
  • Loading branch information
@Vytax
Vytax committed Feb 19, 2024
1 parent 080f23b commit 88ac205
Show file tree
Hide file tree
Showing 16 changed files with 218 additions and 135 deletions.
24 changes: 16 additions & 8 deletions python/PyQt6/core/auto_generated/providers/arcgis/qgsarcgisportalutils.sip.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Utility functions for working with ArcGIS REST services.
%End
public:

static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0 );
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON user info for the specified user name.

Expand All @@ -36,6 +36,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - JSON user info
- errorTitle: title summary of any encountered errors
Expand All @@ -44,7 +45,7 @@ If ``user`` is blank then the user associated with the current logon details wil
.. versionadded:: 3.24
%End

static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0 ) /Deprecated/;
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON user info for the specified user name. Only to avoid API break.

Expand All @@ -55,6 +56,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - JSON user info
- errorTitle: title summary of any encountered errors
Expand All @@ -64,7 +66,7 @@ If ``user`` is blank then the user associated with the current logon details wil
use the version with :py:class:`QgsHttpHeaders` instead
%End

static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0 );
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all groups which the specified user name is a member of.

Expand All @@ -75,6 +77,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON group info
- errorTitle: title summary of any encountered errors
Expand All @@ -83,7 +86,7 @@ If ``user`` is blank then the user associated with the current logon details wil
.. versionadded:: 3.24
%End

static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0 ) /Deprecated/;
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all groups which the specified user name is a member of. Only to avoid API break.

Expand All @@ -94,6 +97,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON group info
- errorTitle: title summary of any encountered errors
Expand All @@ -103,7 +107,7 @@ If ``user`` is blank then the user associated with the current logon details wil
use the version with :py:class:`QgsHttpHeaders` instead
%End

static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100 );
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``.

Expand All @@ -113,6 +117,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -121,7 +126,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
.. versionadded:: 3.24
%End

static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100 ) /Deprecated/;
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.

Expand All @@ -131,6 +136,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -142,7 +148,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI

static QVariantList retrieveGroupItemsOfType( const QString &contentUrl, const QString &groupId, const QString &authcfg,
const QList< int > &itemTypes,
QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100 );
QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``.

Expand All @@ -153,6 +159,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -163,7 +170,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI

static QVariantList retrieveGroupItemsOfType( const QString &contentUrl, const QString &groupId, const QString &authcfg,
const QList< int > &itemTypes,
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100 ) /Deprecated/;
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.

Expand All @@ -174,6 +181,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand Down
24 changes: 16 additions & 8 deletions python/core/auto_generated/providers/arcgis/qgsarcgisportalutils.sip.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Utility functions for working with ArcGIS REST services.
%End
public:

static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0 );
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON user info for the specified user name.

Expand All @@ -36,6 +36,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - JSON user info
- errorTitle: title summary of any encountered errors
Expand All @@ -44,7 +45,7 @@ If ``user`` is blank then the user associated with the current logon details wil
.. versionadded:: 3.24
%End

static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0 ) /Deprecated/;
static QVariantMap retrieveUserInfo( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON user info for the specified user name. Only to avoid API break.

Expand All @@ -55,6 +56,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - JSON user info
- errorTitle: title summary of any encountered errors
Expand All @@ -64,7 +66,7 @@ If ``user`` is blank then the user associated with the current logon details wil
use the version with :py:class:`QgsHttpHeaders` instead
%End

static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0 );
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all groups which the specified user name is a member of.

Expand All @@ -75,6 +77,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON group info
- errorTitle: title summary of any encountered errors
Expand All @@ -83,7 +86,7 @@ If ``user`` is blank then the user associated with the current logon details wil
.. versionadded:: 3.24
%End

static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0 ) /Deprecated/;
static QVariantList retrieveUserGroups( const QString &communityUrl, const QString &user, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all groups which the specified user name is a member of. Only to avoid API break.

Expand All @@ -94,6 +97,7 @@ If ``user`` is blank then the user associated with the current logon details wil
:param authcfg: authentication configuration ID
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON group info
- errorTitle: title summary of any encountered errors
Expand All @@ -103,7 +107,7 @@ If ``user`` is blank then the user associated with the current logon details wil
use the version with :py:class:`QgsHttpHeaders` instead
%End

static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100 );
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``.

Expand All @@ -113,6 +117,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -121,7 +126,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
.. versionadded:: 3.24
%End

static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100 ) /Deprecated/;
static QVariantList retrieveGroupContent( const QString &contentUrl, const QString &groupId, const QString &authcfg, QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.

Expand All @@ -131,6 +136,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -142,7 +148,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI

static QVariantList retrieveGroupItemsOfType( const QString &contentUrl, const QString &groupId, const QString &authcfg,
const QList< int > &itemTypes,
QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100 );
QString &errorTitle /Out/, QString &errorText /Out/, const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(), QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() );
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``.

Expand All @@ -153,6 +159,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand All @@ -163,7 +170,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI

static QVariantList retrieveGroupItemsOfType( const QString &contentUrl, const QString &groupId, const QString &authcfg,
const QList< int > &itemTypes,
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100 ) /Deprecated/;
QString &errorTitle /Out/, QString &errorText /Out/, const QMap< QString, QVariant > &requestHeaders, QgsFeedback *feedback = 0, int pageSize = 100, const QString &urlPrefix = QString() ) /Deprecated/;
%Docstring
Retrieves JSON definitions for all items which belong the the specified ``groupId``. Only to avoid API break.

Expand All @@ -174,6 +181,7 @@ Retrieves JSON definitions for all items which belong the the specified ``groupI
:param requestHeaders: optional additional request headers
:param feedback: optional feedback argument for cancellation support
:param pageSize: number of results to retrieve for each request. Maximum value is 100.
:param urlPrefix: http web proxy url prefix

:return: - a list of JSON item info for all items within the group
- errorTitle: title summary of any encountered errors
Expand Down
Loading

0 comments on commit 88ac205

Please sign in to comment.