Toggle between feature request modes

// [WriteFile Name=ToggleBetweenFeatureRequestModes, Category=Features]
// [Legal]
// Copyright 2025 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

// sample headers
#include "ToggleBetweenFeatureRequestModes.h"

// ArcGIS Maps SDK headers
#include "FeatureLayer.h"
#include "GeodatabaseTypes.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Polygon.h"
#include "QueryParameters.h"
#include "ServiceFeatureTable.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>
#include <QUrl>

using namespace Esri::ArcGISRuntime;

ToggleBetweenFeatureRequestModes::ToggleBetweenFeatureRequestModes(QObject* parent /* = nullptr */) :
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISTopographic, this))
{
  const QUrl serviceUrl = QUrl("https://services2.arcgis.com/ZQgQTuoyBrtmoGdP/arcgis/rest/services/Trees_of_Portland/FeatureServer/0");

  // Create a feature table for the trees of Portland feature service.
  // The feature request mode for this service feature table is OnInteractionCache by default.
  m_treeFeatureTable = new ServiceFeatureTable(serviceUrl, this);

  m_treeFeatureLayer = new FeatureLayer(m_treeFeatureTable, this);

  m_map->operationalLayers()->append(m_treeFeatureLayer);
}

ToggleBetweenFeatureRequestModes::~ToggleBetweenFeatureRequestModes() = default;

void ToggleBetweenFeatureRequestModes::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<ToggleBetweenFeatureRequestModes>("Esri.Samples", 1, 0, "ToggleBetweenFeatureRequestModesSample");
}

MapQuickView* ToggleBetweenFeatureRequestModes::mapView() const
{
  return m_mapView;
}

// Set the view (created in QML)
void ToggleBetweenFeatureRequestModes::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
  {
    return;
  }

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  m_map->setInitialViewpoint(Viewpoint(45.5266, -122.6219, 6000));

  emit mapViewChanged();
}

// Use this method for manual cache.
void ToggleBetweenFeatureRequestModes::fetchCacheManually()
{
  const Geometry geometry = m_mapView->visibleArea();

  // Create new query object that contains parameters to query specific request types.
  QueryParameters params;
  params.setGeometry(geometry);

  // Create list of the fields that are returned from the service.
  // Using "*" will return all fields. This can be replaced to return certain fields.
  const QStringList outFields = {"*"};
  constexpr bool clearCache = true;

  // Populate feature table with the data based on query.
  m_treeFeatureTable->populateFromServiceAsync(params, clearCache, outFields, this);
}

// Use this method to set feature request mode.
void ToggleBetweenFeatureRequestModes::setFeatureRequestMode(Esri::ArcGISRuntime::FeatureRequestMode featureRequestMode)
{
  m_treeFeatureTable->setFeatureRequestMode(featureRequestMode);
}

// [WriteFile Name=ToggleBetweenFeatureRequestModes, Category=Features]
// [Legal]
// Copyright 2025 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#ifndef TOGGLEBETWEENFEATUREREQUESTMODES_H
#define TOGGLEBETWEENFEATUREREQUESTMODES_H

// ArcGIS Maps SDK headers
#include "GeodatabaseTypes.h"

// Qt headers
#include <QObject>

namespace Esri::ArcGISRuntime
{
  class Map;
  class MapQuickView;
  class FeatureLayer;
  class ServiceFeatureTable;
  enum class FeatureRequestMode;
} // namespace Esri::ArcGISRuntime

Q_MOC_INCLUDE("MapQuickView.h");

class ToggleBetweenFeatureRequestModes : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)

public:
  enum class RequestMode
  {
    Cache = static_cast<int>(Esri::ArcGISRuntime::FeatureRequestMode::OnInteractionCache),
    NoCache = static_cast<int>(Esri::ArcGISRuntime::FeatureRequestMode::OnInteractionNoCache),
    ManualCache = static_cast<int>(Esri::ArcGISRuntime::FeatureRequestMode::ManualCache)
  };
  Q_ENUM(RequestMode)

  explicit ToggleBetweenFeatureRequestModes(QObject* parent = nullptr);
  ~ToggleBetweenFeatureRequestModes() override;

  static void init();

  Q_INVOKABLE void setFeatureRequestMode(Esri::ArcGISRuntime::FeatureRequestMode featureRequestMode);
  Q_INVOKABLE void fetchCacheManually();

signals:
  void mapViewChanged();

private:
  Esri::ArcGISRuntime::MapQuickView* mapView() const;
  void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::ServiceFeatureTable* m_treeFeatureTable = nullptr;
  Esri::ArcGISRuntime::FeatureLayer* m_treeFeatureLayer = nullptr;
};

#endif // TOGGLEBETWEENFEATUREREQUESTMODES_H

// [WriteFile Name=ToggleBetweenFeatureRequestModes, Category=Features]
// [Legal]
// Copyright 2025 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

import QtQuick
import QtQuick.Controls
import Esri.Samples

Item {

    property var currentFeatureRequestMode;

    onCurrentFeatureRequestModeChanged: {
        model.setFeatureRequestMode(currentFeatureRequestMode);
    }

    // add a mapView component
    MapView {
        id: view
        anchors.fill: parent

        Component.onCompleted: {
            // Set and keep the focus on MapView to enable keyboard navigation
            forceActiveFocus();
        }
    }

    // Declare the C++ instance which creates the map etc. and supply the view
    ToggleBetweenFeatureRequestModesSample {
        id: model
        mapView: view
    }

    // Add a background to the column
    Rectangle {
        anchors.fill: column
        radius: 10
        border.width: 1
        color: palette.base

        MouseArea {
            anchors.fill: parent
            acceptedButtons: Qt.LeftButton | Qt.RightButton
            onClicked: mouse => mouse.accepted = true
            onDoubleClicked: mouse => mouse.accepted = true
            onWheel: wheel => wheel.accepted = true
        }
    }

    Column {
        id: column
        spacing: 15
        padding: 10

        ComboBox {
            id: request_mode
            width: 200
            model: ["Cache", "No Cache", "Manual Cache"]
            onCurrentIndexChanged: {
                switch (currentIndex) {
                    case 0:
                        currentFeatureRequestMode = ToggleBetweenFeatureRequestModesSample.Cache
                        break
                    case 1:
                        currentFeatureRequestMode = ToggleBetweenFeatureRequestModesSample.NoCache
                        break
                    case 2:
                        currentFeatureRequestMode = ToggleBetweenFeatureRequestModesSample.ManualCache
                        break
                }
            }
        }

        Button {
            id: populate
            width: 200
            anchors.horizontalCenter: parent.horizontalCenter
            text: qsTr("Populate")
            enabled : currentFeatureRequestMode === ToggleBetweenFeatureRequestModesSample.ManualCache
            onClicked: {
                model.fetchCacheManually();
            }
        }
    }
}

// Copyright 2025 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// sample headers
#include "ToggleBetweenFeatureRequestModes.h"

// ArcGIS Maps SDK headers
#include "ArcGISRuntimeEnvironment.h"

// Qt headers
#include <QCommandLineParser>
#include <QDir>
#include <QGuiApplication>
#include <QQmlApplicationEngine>

// Platform specific headers
#ifdef Q_OS_WIN
#include <Windows.h>
#endif

int main(int argc, char* argv[])
{
  QGuiApplication app(argc, argv);
  app.setApplicationName(QString("ToggleBetweenFeatureRequestModes"));

  // Use of ArcGIS location services, such as basemap styles, geocoding, and routing services,
  // requires an access token. For more information see
  // https://links.esri.com/arcgis-runtime-security-auth.

  // The following methods grant an access token:

  // 1. User authentication: Grants a temporary access token associated with a user's ArcGIS account.
  // To generate a token, a user logs in to the app with an ArcGIS account that is part of an
  // organization in ArcGIS Online or ArcGIS Enterprise.

  // 2. API key authentication: Get a long-lived access token that gives your application access to
  // ArcGIS location services. Go to the tutorial at https://links.esri.com/create-an-api-key.
  // Copy the API Key access token.

  const QString accessToken = QString("");

  if (accessToken.isEmpty())
  {
    qWarning() << "Use of ArcGIS location services, such as the basemap styles service, requires"
               << "you to authenticate with an ArcGIS account or set the API Key property.";
  }
  else
  {
    Esri::ArcGISRuntime::ArcGISRuntimeEnvironment::setApiKey(accessToken);
  }

  // Initialize the sample
  ToggleBetweenFeatureRequestModes::init();

  // Initialize application view
  QQmlApplicationEngine engine;
  // Add the import Path
  engine.addImportPath(QDir(QCoreApplication::applicationDirPath()).filePath("qml"));

#ifdef ARCGIS_RUNTIME_IMPORT_PATH_2
  engine.addImportPath(ARCGIS_RUNTIME_IMPORT_PATH_2);
#endif

  // Set the source
  engine.load(QUrl("qrc:/Samples/Features/ToggleBetweenFeatureRequestModes/main.qml"));

  return app.exec();
}

// Copyright 2025 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import QtQuick.Controls
import Esri.Samples

ApplicationWindow {
    visible: true
    width: 800
    height: 600

    ToggleBetweenFeatureRequestModes {
        anchors.fill: parent
    }
}