ArcGIS Runtime SDK for iOS: AGSArcGISRuntimeEnvironment Class Reference
ArcGIS Runtime SDK for iOS  100.11
AGSArcGISRuntimeEnvironment Class Reference

Description

Class representing the ArcGIS Runtime Environment.

A class representing the ArcGIS Runtime Environment.

Since
100
Inheritance diagram for AGSArcGISRuntimeEnvironment:

Class Methods

(AGSLicense *) + license
 
(nullable AGSLicenseResult *) + setLicenseInfo:error:
 
(nullable AGSLicenseResult *) + setLicenseKey:error:
 
(nullable AGSLicenseResult *) + setLicenseKey:extensions:error:
 

Properties

NSString * APIKey
 

Method Documentation

◆ license

+ (AGSLicense*) license

Returns the current license details about the application.

Since
100

◆ setLicenseInfo:error:

+ (nullable AGSLicenseResult*) setLicenseInfo: (AGSLicenseInfo *)  licenseInfo
error: (NSError **)  error 

License the application for deployment using a 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.

ArcGIS Runtime must be licensed to be used in a production application. The application can be licensed at any one of the four levels; Lite, Basic, Standard, and Advanced; where each level enables additional capabilities fundamental to ArcGIS Runtime. Extension licenses are optional and provide access to supplementary capabilities, analysis tools, and data. By default, an ArcGIS Runtime application will run under a developer license (mode) where all licensed capabilities are available.

Parameters
licenseInfoto use
errorthat is popuplated if there was an error in using the license key
Returns
Result of the operation
Since
100

◆ setLicenseKey:error:

+ (nullable AGSLicenseResult*) setLicenseKey: (NSString *)  licenseKey
error: (NSError **)  error 

License the application for deployment using an ESRI license string.

ArcGIS Runtime must be licensed to be used in a production application. The application can be licensed at any one of the four levels; Lite, Basic, Standard, and Advanced; where each level enables additional capabilities fundamental to ArcGIS Runtime. Extension licenses are optional and provide access to supplementary capabilities, analysis tools, and data. By default, an ArcGIS Runtime application will run under a developer license (mode) where all licensed capabilities are available.

Parameters
licenseKeyThe lite, basic, standard, or advanced ESRI license string.
errorthat is popuplated if there was an error in using the license key
Returns
Result of the operation
Since
100

◆ setLicenseKey:extensions:error:

+ (nullable AGSLicenseResult*) setLicenseKey: (NSString *)  licenseKey
extensions: (NSArray< NSString * > *)  extensions
error: (NSError **)  error 

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

ArcGIS Runtime must be licensed to be used in a production application. The application can be licensed at any one of the four levels; Lite, Basic, Standard, and Advanced; where each level enables additional capabilities fundamental to ArcGIS Runtime. Extension licenses are optional and provide access to supplementary capabilities, analysis tools, and data. By default, an ArcGIS Runtime application will run under a developer license (mode) where all licensed capabilities are available.

Parameters
licenseKeyThe lite, basic, standard, or advanced ESRI license string.
extensionsAn array of extension license strings.
errorthat is popuplated if there was an error in using the license key
Returns
Result of the operation
Since
100

Property Documentation

◆ APIKey

- (NSString*) APIKey
readwritenonatomiccopy

The default API key to access API key enabled services and resources in ArcGIS Online.

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. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account. Set the API key on a specific AGSAPIKeyResource to override this default key.

Since
100.10