arcgis-maps-kotlin/com.arcgismaps/ArcGISEnvironment

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

apiKey

var apiKey: ApiKey?

An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services.

apiVersion

val apiVersion: String

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

applicationContext

var applicationContext: Context?

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.

arcadeConsoleMessage

val arcadeConsoleMessage: SharedFlow<ArcadeConsoleMessageEvent>

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.

arcGISHttpClient

val arcGISHttpClient: ArcGISHttpClient

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.

authenticationManager

val authenticationManager: AuthenticationManager

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

license

val license: License

Get the license details about the application.

serviceCurveGeometryMode

var serviceCurveGeometryMode: ServiceCurveGeometryMode

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

configureArcGISHttpClient

fun configureArcGISHttpClient(configure: ArcGISHttpClient.Builder.() -> Unit? = null)

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.

setLicense

@JvmStatic

fun setLicense(licenseInfo: LicenseInfo): LicenseResult?

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.

@JvmStatic

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.