class OfflineMapParametersKey

A key comprising of a service URL and type of an online service. The key is used to lookup values in a dictionary exposed by a GenerateOfflineMapParameterOverrides. GenerateOfflineMapParameterOverrides consist of instances of data type specific parameters GenerateGeodatabaseParameters, ExportTileCacheParameters and ExportVectorTilesParameters. Each instance is associated with the service URL that the parameters will be sent to when taking the given data offline. The data type specific parameters can be retrieved from their respective dictionaries on GenerateOfflineMapParameterOverrides with an instance of OfflineMapParametersKey. A key instance for a particular layer can be constructed by calling OfflineMapParametersKey.OfflineMapParametersKey(Layer). For a table, call OfflineMapParametersKey.OfflineMapParametersKey(ServiceFeatureTable). For a utility network, call OfflineMapParametersKey.OfflineMapParametersKey(UtilityNetwork). Use the key with the dictionary returned by one of these properties: GenerateOfflineMapParameterOverrides.getGenerateGeodatabaseParameters(), GenerateOfflineMapParameterOverrides.getExportVectorTilesParameters(), GenerateOfflineMapParameterOverrides.getExportTileCacheParameters(). The particular dictionary property will be determined by the OfflineMapParametersKey.getType() property. Note that a given parameters key/value pair may be shared by multiple layers in the map: for example a single GenerateGeodatabaseParameters could represent the online settings for multiple feature layers and tables which all access the same underlying feature service.


Link copied to clipboard
fun OfflineMapParametersKey(layer: Layer)

Create an offline map parameters key for the given layer. Layers that are supported for offline use are:

Link copied to clipboard
fun OfflineMapParametersKey(table: ServiceFeatureTable)

Create an offline map parameters key for the given table. The returned key can be used to retrieve a data type specific parameter object from the dictionary returned by GenerateOfflineMapParameterOverrides.getGenerateGeodatabaseParameters().

Link copied to clipboard
fun OfflineMapParametersKey(utilityNetwork: UtilityNetwork)

Create an offline map parameters key for the specified UtilityNetwork. An UtilityNetwork with URI that points to a feature service which returns true for SyncCapabilities.getSupportsUtilityNetworkSystem() is supported for offline use.


Link copied to clipboard
fun clone(): OfflineMapParametersKey
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int


Link copied to clipboard
val serviceUrl: String

Service URL of this key. The service URL is the URL associated with a data specific parameter object in one of the dictionaries owned by a GenerateOfflineMapParameterOverrides instance.

Link copied to clipboard
val type: OfflineMapParametersType

The parameter type of this key. The type of this key indicates which GenerateOfflineMapParameterOverrides dictionary this key belongs to: | Parameter Type | Dictionary | |-------------------------------------------------|--------------------------------------------------------------------------| | OfflineMapParametersType.GenerateGeodatabase | GenerateOfflineMapParameterOverrides.getGenerateGeodatabaseParameters() | | OfflineMapParametersType.ExportVectorTiles | GenerateOfflineMapParameterOverrides.getExportVectorTilesParameters() | | OfflineMapParametersType.ExportTileCache | GenerateOfflineMapParameterOverrides.getExportTileCacheParameters() |