License class final
Details of license.
Until an app is licensed, it runs at the Developer license level. All functionality is available, but the map display is watermarked and a message is logged stating that the app is in developer mode.
A deployed app needs to be run at minimum with the Lite license level to disable the map watermark. The Lite, Basic, Standard, or Advanced license level is set by calling ArcGISEnvironment.setLicenseUsingKey with a license string obtained from the ArcGIS for Developers website or Esri Customer Service. With the varying license levels, a subset of functionality is available. Any attempt to use licensed functionality that is not available at the current license level will log or emit error messages.
To get Lite, Basic, Standard, or Advanced license level functionality, a user app is licensed in one of two ways:
- With license information retrieved after logging in to a portal (Lite and Basic levels).
- With a license string acquired from the ArcGIS for Developers website or Esri Customer Service.
To license with a license string, call ArcGISEnvironment.setLicenseUsingKey.
To validate with information from a portal, you need a LicenseInfo instance. You can get one by calling Portal.fetchLicenseInfo. Pass the LicenseInfo to ArcGISEnvironment.setLicenseUsingInfo.
Both of these methods return a LicenseResult that reports the status of the license. Note that there is a 30-day timeout when using LicenseInfo. If the app is licensed using this method, the user must log in to the portal again before licensing the app. When this period has expired, calling ArcGISEnvironment.setLicenseUsingInfo returns a LicenseResult which contains license status of LicenseStatus.loginRequired, and the app continues to run at the current license level (default is LicenseLevel.developer).
- Implemented types
Properties
- expiry → DateTime
-
License expiry date and time in UTC.
no setter
-
extensions
→ List<
ExtensionLicense> -
The collection of extension licenses for the app.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isPermanent → bool
-
True if a license is perpetual, false otherwise.
no setter
- licenseLevel → LicenseLevel
-
The current license level set in the app. See LicenseLevel for available
levels.
no setter
- licenseStatus → LicenseStatus
-
The current license status of the provided license.
no setter
- licenseType → LicenseType
-
The license type of the current license.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited