java.lang.Object
com.esri.arcgisruntime.LicenseInfo
- All Implemented Interfaces:
JsonSerializable
Contains information for licensing an app from a portal instance. To license an application from a portal, you need a
LicenseInfo instance. This can be obtained by calling
Portal.fetchLicenseInfoAsync()
. The LicenseInfo can then
be used to authorize this app by calling ArcGISRuntimeEnvironment.setLicense(LicenseInfo)
.
Note that LicenseInfo
is only available when a user is logged in to the portal.
The use of some members in this API requires a specific license level. Please refer to Licensing details by class.
- Since:
- 100.0.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic LicenseInfo
Creates a LicenseInfo instance from a JSON string.LicenseInfos never have any unknown JSON so this returns an empty Map.LicenseInfos never have any unsupported JSON so this returns an empty Map.final String
toJson()
Returns the LicenseInfo as a JSON string representation.
-
Method Details
-
fromJson
Creates a LicenseInfo instance from a JSON string.- Parameters:
json
- a JSON string that represents a LicenseInfo- Returns:
- a LicenseInfo instance
- Throws:
IllegalArgumentException
- if json is null or empty- Since:
- 100.0.0
- See Also:
-
toJson
Returns the LicenseInfo as a JSON string representation. This JSON string can be persisted to disk and reapplied to the app by calling fromJson, which returns a new instance of LicenseInfo to be passed toArcGISRuntimeEnvironment.setLicense(LicenseInfo)
. The LicenseInfo is valid for 30 days before it expires and requires the user to log in to the portal to acquire a new LicenseInfo object. This approach is particularly useful for licensing an app when there is no network connection available.- Specified by:
toJson
in interfaceJsonSerializable
- Returns:
- a license string in JSON format
- Since:
- 100.0.0
- See Also:
-
getUnknownJson
LicenseInfos never have any unknown JSON so this returns an empty Map.- Specified by:
getUnknownJson
in interfaceJsonSerializable
- Returns:
- an empty unmodifiable Map
- Since:
- 100.0.0
-
getUnsupportedJson
LicenseInfos never have any unsupported JSON so this returns an empty Map.- Specified by:
getUnsupportedJson
in interfaceJsonSerializable
- Returns:
- an empty unmodifiable Map
- Since:
- 100.0.0
-