ArcGISEnvironment

Provides access to and manipulation of environment settings, such as configurations for the operating environment and licenses for deployment.

Since

200.1.0

Properties

Link copied to clipboard

The API key allows your app to access ArcGIS location services and private portal items. An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS Location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

Link copied to clipboard

Indicates the current version of the ArcGIS Maps SDK for Kotlin.

Link copied to clipboard

The Context to be set by the user for use in creating View types and accessing resources. When setting this property the underlying Context.applicationContext will be used. Setting this property will also cause the application's package name to be appended to any TokenCredential.referer.

Link copied to clipboard

A SharedFlow to be invoked whenever a console message is sent from any Arcade script. This flow allows clients to collect messages from evaluating an Arcade script expression in an attribute rule, labeling, popup, dictionary renderer, geotrigger, and more.

Link copied to clipboard

The ArcGISHttpClient used to make network requests. An ArcGISHttpClient is set by default, setting a new ArcGISHttpClient is only required if the ArcGISHttpClient needs to be customized, for example in order to intercept network requests, see ArcGISEnvironment.configureArcGISHttpClient.

Link copied to clipboard

Responsible for issuing authentication challenges and managing credential stores of secured resources.

Link copied to clipboard

Get the license details about the application.

Link copied to clipboard

Determines if curve geometries are fetched from and sent to services that support them. By default, this API does not fetch curves in geometries or act as a true curve client, which means:

Functions

Link copied to clipboard

Configures the ArcGISEnvironment with a new ArcGISHttpClient. Configuring a new ArcGISHttpClient should be done on application initialization, before any network requests may be invoked by the API or user code.

Link copied to clipboard

License an application for deployment using license info for named-user access. A license info instance can be obtained from a portal for the current logged in user. The license info instance is only valid for 30 days so the user will be required to log into the portal again when this expires.

fun setLicense(licenseKey: LicenseKey, LicenseExtensions: List<LicenseKey> = listOf()): LicenseResult?

License an application for deployment using an ESRI license string and one or more extension license strings.