Obsolete Members for ArcGISRuntime

The following members of class ArcGISRuntime are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Classes

Types

Classes

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::AuthenticationChallenge

This class is deprecated. We strongly advise against using it in new code.

Instances of this class represent an authentication challenge that was raised because a security error was encountered while trying to access a secured network resource. You can connect to the AuthenticationManager::authenticationChallenge signal to handle challenges raised from security errors.

To satisfy the challenge, you need to do one of the following:

• Call continueWithCredential with a valid credential. The task that issued the challenge will try to connect to the resource using the credential.
• Call continueWithUsernamePassword() with a valid username and password which is applied to the credential to continue with the request.
• Call continueWithOAuthAuthorizationCode() with a valid OAuth authorization code which is applied to the credential to continue to authenticate using OAuth.
• Call continueWithClientCertificate() with the index of the client certificate to use, obtained from AuthenticationManager::clientCertificateInfos which is applied to the credential to continue with the request.
• Call continueWithSslHandshake() if the challenge was due to an SSL error, such as an untrusted server certificate, and you want to either trust of reject the network request.
• Call cancel() to cancel the challenge. The task that issued the challenge will fail to connect to the resource and should emit an error signal.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::AuthenticationManager

This class is deprecated. We strongly advise against using it in new code.

This class allows you to manage authentication/security related tasks.

It emits the authenticationChallenge signal whenever an authentication or security issue is encountered anywhere in the API.

The following challenges can be raised by the AuthenticationManager:

• AuthenticationChallengeType::UsernamePassword - Challenges needing username and/or password authentication.
• AuthenticationChallengeType::OAuth - Challenges needing an OAuth authorization code.
• AuthenticationChallengeType::ClientCertificate - Challenges needing a client certificate to be provided.
• AuthenticationChallengeType::SslHandshake - Challenges needing a response to certain SslError errors, usually an untrusted host due to a self-signed certificate.

To handle authentication challenges in the UI automatically in QML, import the Esri.ArcGISRuntime.Toolkit module and declare the AuthenticationView component.

To see a full example of using the AuthenticationView with the AuthenticationManager, please see the token authentication sample.

It also contains an instance of a CredentialCache which maintains a cache of credentials, in memory, that have been previously used to satisfy authentication challenges. This allows a credential to be reused where appropriate, and prevents unnecessary or duplicate challenges from being issued while accessing secure resources from the same security realm. Caching happens automatically if isCredentialCacheEnabled() is true.

• Access portal user info: Retrieve a user's details via a Portal.
• Integrated windows authentication: Uses Windows credentials to access services hosted on a portal secured with Integrated Windows Authentication (IWA).
• Show organization basemaps: Connect to Portal to give users access to their organization's basemaps.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.1, deprecated] class ArcGISRuntime::BingMapsLayer

This class is deprecated. We strongly advise against using it in new code.

A Bing maps layer displays map content from a Bing Maps web service, providing access to static map tiles and imagery meta-data. Map style and culture can be customized prior to loading the layer.

Functional characteristics

Bing maps require an API key from Microsoft. There are two ways to set this key:

• By providing an ArcGIS portal configured with a Bing Maps key. For more information, see "How to install a Microsoft Bing Key"
• By providing a Bing Maps key directly for this layer. For more information, see "Getting a Bing Maps Key"

A Bing maps layer will fail to load if it does not have a Bing map key or a Portal from where it can get the Bing map key. In this situation, you can set the key and call Loadable::retryLoad. To use the BingMapsLayer you must adhere to Microsoft's Mobile Brand Guidelines.

Bing maps layers do not support identify, query, selection, or time.

Performance characteristics

Bing maps layers perform similarly to other tiled layers. Raster tiles are fetched from Bing's servers on demand.

This class was introduced in Esri::ArcGISRuntime 100.1.

See also Layer.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::Credential

This class is deprecated. We strongly advise against using it in new code.

A credential is composed of user account information (username and password), OAuth client information (OAuthClientInfo), or a secured token.

HTTP basic and digest authentication is supported.

Client certificate authentication is also supported for certificate secured resources. Load the certificate information into QSslConfiguration and construct a credential by providing it the SSL configuration.

Relevant samples:

• Access portal user info: Retrieve a user's details via a Portal.
• Add items to portal: This sample demonstrates how to add and delete items in a user's portal.
• Integrated windows authentication: Uses Windows credentials to access services hosted on a portal secured with Integrated Windows Authentication (IWA).
• Show organization basemaps: Connect to Portal to give users access to their organization's basemaps.

This class was introduced in Esri::ArcGISRuntime 100.0.

See also OAuthClientInfo.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::CredentialCache

This class is deprecated. We strongly advise against using it in new code.

An instance of this class is available through the AuthenticationManager. It represents a cache containing credentials. All objects and tasks share this instance and could potentially reuse a credential if they need to access the same security realm.

The URL acts as the lookup key into the cache and represents one of the following:

• The full path to a server from an ArcGIS Server.
• The full path to a portal, portal item, or hosted item.
• The URL to a portal, such as https://www.arcgis.com.
• The URL to an ArcGIS Server instance, such as https://host(:port)/instance.

Automatic caching happens when credentials (that is, username, password, token, or OAuth client information) are required when connecting to a secure service hosted by ArcGIS Server, ArcGIS Online, or Federated by Portal. Upon successful connection to one of these secure services, the credential is cached in the CredentialCache and reused again whenever subsequent connections are made to the secure service.

Caching happens automatically if AuthenticationManager::isCredentialCacheEnabled is enabled. In addition, the CredentialCache class contains public methods to manipulate the cache contents.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::OAuthClientInfo

This class is deprecated. We strongly advise against using it in new code.

Applications can generate tokens that can access ArcGIS Online content and services using OAuth client information configured for OAuthMode::App.

This information can also allow ArcGIS Online users to authorize your application to access ArcGIS Online content and services on their behalf by configuring with OAuthMode::User. Usage will be billed to that user and you can access that user's private content.

Your client secret should never be accessible to users or other developers. Treat it like a password.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.1, deprecated] class ArcGISRuntime::PopupAttachmentListModel

This class is deprecated. We strongly advise against using it in new code.

Obtain a PopupAttachmentListModel from a PopupAttachmentManager.

The model will automatically fetch attachments from the underlying features so that they can be displayed in a view.

This class is a subclass of QAbstractListModel.

The model returns data for the following roles:

This class was introduced in Esri::ArcGISRuntime 100.1.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupAttachmentManager

This class is deprecated. We strongly advise against using it in new code.

In addition to the available constructors on PopupAttachmentManager, you can obtain a PopupAttachmentManager from PopupManager::attachmentManager.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupAttributeListModel

This class is deprecated. We strongly advise against using it in new code.

Obtain a PopupAttributeListModel from the PopupManager.

The model returns data for the following roles:

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::PopupManager

This class is deprecated. We strongly advise against using it in new code.

This class works in conjunction with the PopupView in the ArcGIS Maps SDK Toolkit. The PopupView is used to display information about a GeoElement. For example, a PopupView could be used to display the attributes of an ArcGISFeature that is stored in a Feature Service. PopupManager provides the PopupView with the content to display in the view. It also contains many helper functions and properties to assist the PopupView with displaying and editing information related to the associated GeoElement.

An example workflow for displaying a PopupView using a PopupManager would be:

• Declare a PopupView and anchor it to a desired location.
• Perform an identify operation on a GeoView and select a Feature from the identify result.
• Create a Popup from the Feature.
• Optionally obtain the Popup's PopupDefinition and set the title, whether to show attachments, and so on.
• Create a PopupManager from the Popup.
• Assign the PopupView's popupManager property the PopupManager created in the previous step.
• Call the show() method to display the PopupView.
• Call the dismiss() method to hide the PopupView.

In order to use the PopupManager with a QML UI, the PopupManager, PopupAttachmentManager, PopupAttachmentListModel, and PopupAttributeListModel classes must be registered as QML Types. For example, the following lines could be added to the main.cpp to register the classes under the Esri.Samples namespace:

qmlRegisterUncreatableType<PopupManager>("Esri.Samples", 1, 0, "PopupManager", "PopupManager is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentManager>("Esri.Samples", 1, 0, "PopupAttachmentManager", "PopupAttachmentManager is uncreateable");
qmlRegisterUncreatableType<PopupAttributeListModel>("Esri.Samples", 1, 0, "PopupAttributeListModel", "PopupAttributeListModel is uncreateable");
qmlRegisterUncreatableType<PopupAttachmentListModel>("Esri.Samples", 1, 0, "PopupAttachmentListModel", "PopupAttachmentListModel is uncreateable");

Relevant samples:

• Display clusters: Display a web map with a point feature layer that has feature reduction enabled to aggregate points into clusters.
• Show popup: Show predefined popups from a web map.

This class was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.1, deprecated] class ArcGISRuntime::RemoteResource

This class is deprecated. We strongly advise against using it in new code.

This interface adopted by classes whose objects need to access remote network resources, potentially in a secured manner. For example, a web service or a file on a web server that could require credentials to access.

This class was introduced in Esri::ArcGISRuntime 100.1.

[since Esri::ArcGISRuntime 100.12, deprecated] class ArcGISRuntime::SketchEditConfiguration

This class is deprecated. We strongly advise against using it in new code.

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] class ArcGISRuntime::SketchEditor

This class is deprecated. We strongly advise against using it in new code.

Instances of this class represent a sketch editor that allows the user to interactively sketch geometries. You can sketch point, polygon, and polyline geometries from scratch, modify existing geometries, insert and remove vertices, undo and redo changes, and so on.

The sketch editor must be set on the view using MapView::setSketchEditor and then started to perform the sketch based on user interactions.

A new GeometryEditor class provides a successor to this class, supporting a wider array of use cases and providing a foundation for additional future geometry editing capabilities. If starting new development, use GeometryEditor in preference to SketchEditor.

since Esri::ArcGISRuntime 200.2

Use GeometryEditor instead.

Relevant samples:

• Sketch on map: This sample demonstrates how to use the Sketch Editor to edit or sketch a new point, line, or polygon geometry on to a map.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] class ArcGISRuntime::SketchStyle

This class is deprecated. We strongly advise against using it in new code.

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] class ArcGISRuntime::SketchVertex

This class is deprecated. We strongly advise against using it in new code.

If the pointIndex is greater or equal to 0, then it is a vertex. If the insertionIndex is greater or equal to 0, then it is a mid-vertex. This object cannot have both pointIndex and insertionIndex greater or equal to 0. When the associated sketch editor is modifying a point geometry, the partIndex and pointIndex will both be 0 for a valid vertex. Mid-vertices are not allowed for a single point geometry. When the associated sketch editor is modifying a multi-point geometry, the partIndex will be 0 for a valid vertex. Mid-vertices are not allowed for a multi-point geometry.

since Esri::ArcGISRuntime 200.2

SketchEditor and associated types are deprecated. Use GeometryEditor instead.

This class was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.0, deprecated] class ArcGISRuntime::TaskWatcher

This class is deprecated. We strongly advise against using it in new code.

TaskWatcher supports examining the state of a task along with the ability to cancel a task.

This class is only copyable for convenience. All copies are shallow copies and reference the same underlying task.

since Esri::ArcGISRuntime 200.2

This class was introduced in Esri::ArcGISRuntime 100.0.

Type Documentation

[since Esri::ArcGISRuntime 100.0, deprecated] enum class AuthenticationChallengeType

This enum is deprecated. We strongly advise against using it in new code.

Enumerates types of authentication challenges.

This enum was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.0, deprecated] enum class AuthenticationType

This enum is deprecated. We strongly advise against using it in new code.

Enumerates supported authentication types for secured services.

This enum was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.1, deprecated] enum class BingMapsLayerStyle

This enum is deprecated. We strongly advise against using it in new code.

Enumerates the types of layer styles for a Bing Maps layer.

The BingMapsLayerStyle can be one of:

This enum was introduced in Esri::ArcGISRuntime 100.1.

[since Esri::ArcGISRuntime 100.2, deprecated] enum class LoginType

This enum is deprecated. We strongly advise against using it in new code.

Supported login types for portal.

This enum was introduced in Esri::ArcGISRuntime 100.2.

[since Esri::ArcGISRuntime 100.0, deprecated] enum class OAuthMode

This enum is deprecated. We strongly advise against using it in new code.

Enumerates the supported modes for logging in using OAuth.

This enum was introduced in Esri::ArcGISRuntime 100.0.

[since Esri::ArcGISRuntime 100.12, deprecated] enum class SketchCreationMode

This enum is deprecated. We strongly advise against using it in new code.

Enumerates the type of geometry and how it will be created by the SketchEditor.

This enum was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] enum class SketchResizeMode

This enum is deprecated. We strongly advise against using it in new code.

Describes how geometry is resized to fill its allocated space while editing geometry.

The SketchResizeMode can be one of:

This enum was introduced in Esri::ArcGISRuntime 100.12.

[since Esri::ArcGISRuntime 100.12, deprecated] enum class SketchVertexEditMode

This enum is deprecated. We strongly advise against using it in new code.

Describes how vertices respond to user interaction.

The SketchVertexEditMode can be one of:

This enum was introduced in Esri::ArcGISRuntime 100.12.