qgsarcgisportalutils.h

Go to the documentation of this file.

/***************************************************************************
    qgsarcgisportalutils.h
    --------------------
    begin                : December 2020
    copyright            : (C) 2020 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSARCGISPORTALUTILS_H
#define QGSARCGISPORTALUTILS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgshttpheaders.h"
 
#include <QString>
#include <QVariantMap>
 
class QgsFeedback;

 
class CORE_EXPORT QgsArcGisPortalUtils
{
  public:
    static QVariantMap retrieveUserInfo(
      const QString &communityUrl,
      const QString &user,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    Q_DECL_DEPRECATED static QVariantMap retrieveUserInfo(
      const QString &communityUrl,
      const QString &user,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QMap< QString, QVariant > &requestHeaders,
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString()
    ) SIP_DEPRECATED;

    static QVariantList retrieveUserGroups(
      const QString &communityUrl,
      const QString &user,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    Q_DECL_DEPRECATED static QVariantList retrieveUserGroups(
      const QString &communityUrl,
      const QString &user,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QMap< QString, QVariant > &requestHeaders,
      QgsFeedback *feedback = nullptr,
      const QString &urlPrefix = QString()
    ) SIP_DEPRECATED;

    static QVariantList retrieveGroupContent(
      const QString &contentUrl,
      const QString &groupId,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      int pageSize = 100,
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    Q_DECL_DEPRECATED static QVariantList retrieveGroupContent(
      const QString &contentUrl,
      const QString &groupId,
      const QString &authcfg,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QMap< QString, QVariant > &requestHeaders,
      QgsFeedback *feedback = nullptr,
      int pageSize = 100,
      const QString &urlPrefix = QString()
    ) SIP_DEPRECATED;

    static QVariantList retrieveGroupItemsOfType(
      const QString &contentUrl,
      const QString &groupId,
      const QString &authcfg,
      const QList< int > &itemTypes,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QgsHttpHeaders &requestHeaders = QgsHttpHeaders(),
      QgsFeedback *feedback = nullptr,
      int pageSize = 100,
      const QString &urlPrefix = QString(),
      bool forceRefresh = false
    );

    Q_DECL_DEPRECATED static QVariantList retrieveGroupItemsOfType(
      const QString &contentUrl,
      const QString &groupId,
      const QString &authcfg,
      const QList< int > &itemTypes,
      QString &errorTitle SIP_OUT,
      QString &errorText SIP_OUT,
      const QMap< QString, QVariant > &requestHeaders,
      QgsFeedback *feedback = nullptr,
      int pageSize = 100,
      const QString &urlPrefix = QString()
    ) SIP_DEPRECATED;
 
  private:
    static QString typeToString( Qgis::ArcGisRestServiceType type );
};
 
#endif // QGSARCGISPORTALUTILS_H