ArcGIS Runtime SDK for iOS: AGSArcGISMapServiceInfo Class Reference
ArcGIS Runtime SDK for iOS  100.15
List of all members | Instance Methods | Class Methods | Properties
AGSArcGISMapServiceInfo Class Reference

Description

Information about an ArcGIS Server map service.

Instances of this class represent information about an ArcGIS Map service.

Since
100
Inheritance diagram for AGSArcGISMapServiceInfo:
AGSObject <AGSJSONSerializable>

Instance Methods

(nullable id) - toJSON:
 

Class Methods

(nullable id< AGSJSONSerializable >) + fromJSON:error:
 

Properties

NSString * attribution
 
AGSArcGISMapServiceCapabilities * capabilities
 
NSString * contentDescription
 
NSString * currentVersion
 
AGSServiceDocumentInfo * documentInfo
 
BOOL exportTileCacheCompactV2Allowed
 
BOOL exportTilesAllowed
 
AGSEnvelope * fullExtent
 
AGSEnvelope * initialExtent
 
NSArray< AGSMapServiceLayerIDInfo * > * layerInfos
 
NSString * mapName
 
NSInteger maxExportTilesCount
 
NSInteger maxImageHeight
 
NSInteger maxImageWidth
 
NSInteger maxRecordCount
 
double maxScale
 
double minScale
 
NSString * serviceDescription
 
AGSServiceType serviceSourceType
 
BOOL singleFusedMapCache
 
AGSSpatialReference * spatialReference
 
NSArray< NSString * > * supportedImageFormatTypes
 
BOOL supportsDynamicLayers
 
NSArray< AGSMapServiceLayerIDInfo * > * tableInfos
 
AGSTileInfo * tileInfo
 
NSArray< NSURL * > * tileServers
 
AGSServiceTimeInfo * timeInfo
 
AGSUnit * unit
 
NSDictionary< NSString *, id > * unknownJSON
 
NSDictionary< NSString *, id > * unsupportedJSON
 
NSURL * URL
 

Method Documentation

◆ fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject
error: (NSError **)  error 
staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters
JSONObjectNSDictionary or NSArray containing the JSON.
errorencountered during the operation, if any.
Since
100

◆ toJSON:

- (nullable id) toJSON: (NSError **)  error
requiredinherited

Returns JSON representation for this object.

Parameters
errorencountered during the operation, if any.
Returns
NSDictionary or NSArray containing the JSON.
Since
100

Reimplemented in AGSPortalItem.

Property Documentation

◆ attribution

- (NSString*) attribution
readnonatomiccopy

Attribution for the map content of this service.

Since
100

◆ capabilities

- (AGSArcGISMapServiceCapabilities*) capabilities
readnonatomicstrong

The capabilities supported by the service.

Since
100

◆ contentDescription

- (NSString*) contentDescription
readnonatomiccopy

Description of the service's content.

Since
100

◆ currentVersion

- (NSString*) currentVersion
readnonatomiccopy

Version of the server hosting the service.

Since
100

◆ documentInfo

- (AGSServiceDocumentInfo*) documentInfo
readnonatomicstrong

Information about the backing map document used to create the service.

Since
100

◆ exportTileCacheCompactV2Allowed

- (BOOL) exportTileCacheCompactV2Allowed
readnonatomicassign

Whether exporting tiles in compact version 2 format (.tpkx) is supported.

The export tile cache compact version 2 (.tpkx) format now supersedes the compact (.tpk) format across the ArcGIS platform. For more information, see AGSCacheStorageFormatCompactV2.

If this property is YES, the map service supports exporting tiles as .tpkx format. If this property is NO, the service does not support exporting the .tpkx format and you should check AGSArcGISMapServiceInfo::exportTilesAllowed to confirm whether it supports exporting the earlier .tpk format version.

ArcGIS Server/Enterprise AGSArcGISMapServiceInfo::currentVersion, 10.9 or greater, supports exporting tiles as .tpkx. Compact V2 tile caches can also be exported from export-enabled Esri image basemaps and elevation services hosted on ArcGIS Online. For more details on the specification of a .tpkx file format, see https://github.com/Esri/tile-package-spec.

See also
AGSCacheStorageFormat
Since
100.10

◆ exportTilesAllowed

- (BOOL) exportTilesAllowed
readnonatomicassign

Indicates whether exporting tiles in compact format (.tpk) is supported.

This property indicates whether the map service supports exporting tiles as compact (.tpk) format. Exporting tiles allows you to use them as a basemap, operational layer, or an elevation source without network connectivity. See AGSTileCache for information on creating a layer from a local tile cache.

To export tiles, you can use either the AGSExportTileCacheTask or the AGSOfflineMapTask.

There are two formats for exporting a tile cache:

  • Compact (.tpk) is the legacy format for a tile cache. All services that support exporting tiles, support the .tpk format. See AGSCacheStorageFormatCompact.
  • Compact V2 (.tpkx) is the latest format used for exporting tiles, and is widely used across the ArcGIS platform. Check AGSArcGISMapServiceInfo::exportTileCacheCompactV2Allowed to confirm whether the service supports this format.
See also
AGSCacheStorageFormat
Since
100

◆ fullExtent

- (AGSEnvelope*) fullExtent
readnonatomicstrong

Full geographic extent of the service.

Since
100

◆ initialExtent

- (AGSEnvelope*) initialExtent
readnonatomicstrong

Initial geographic extent of the service.

Since
100

◆ layerInfos

- (NSArray<AGSMapServiceLayerIDInfo*>*) layerInfos
readnonatomiccopy

Information about sub-layers in the service.

Since
100

◆ mapName

- (NSString*) mapName
readnonatomiccopy

Name of the map represented by this map service.

Since
100

◆ maxExportTilesCount

- (NSInteger) maxExportTilesCount
readnonatomicassign

The maximum tiles can be exported by the service.

Since
100

◆ maxImageHeight

- (NSInteger) maxImageHeight
readnonatomicassign

The maximum height of a map image that can be generated by the service.

Since
100

◆ maxImageWidth

- (NSInteger) maxImageWidth
readnonatomicassign

The maximum width of a map image that can be generated by the service.

Since
100

◆ maxRecordCount

- (NSInteger) maxRecordCount
readnonatomicassign

The maximum number of features that will be returned by the service for any query operation. Applications should handle re-querying the omitted results when this limit is reached.

Since
100

◆ maxScale

- (double) maxScale
readnonatomicassign

The maximum scale at which contents of the service is visible. If the map is zoomed in beyond this scale, the contents will not be visible.

Since
100

◆ minScale

- (double) minScale
readnonatomicassign

The minimum scale at which contents of the service is visible. If the map is zoomed out beyond this scale, the contents will not be visible.

Since
100

◆ serviceDescription

- (NSString*) serviceDescription
readnonatomiccopy

Description of the ArcGIS map service.

Since
100

◆ serviceSourceType

- (AGSServiceType) serviceSourceType
readnonatomicassign

The type of this ArcGIS service.

Since
100

◆ singleFusedMapCache

- (BOOL) singleFusedMapCache
readnonatomicassign

Indicates whether the map service is cached.

Since
100

◆ spatialReference

- (AGSSpatialReference*) spatialReference
readnonatomicstrong

Spatial reference of the service's geographic data .

Since
100

◆ supportedImageFormatTypes

- (NSArray<NSString*>*) supportedImageFormatTypes
readnonatomiccopy

The supported image format types by service.

Since
100

◆ supportsDynamicLayers

- (BOOL) supportsDynamicLayers
readnonatomicassign

Indicates whether the service supports layers to be dynamically added, removed, reordered, or reconfigured.

Since
100

◆ tableInfos

- (NSArray<AGSMapServiceLayerIDInfo*>*) tableInfos
readnonatomiccopy

Information about (non-spatial) tables in the service.

Since
100

◆ tileInfo

- (AGSTileInfo*) tileInfo
readnonatomicstrong

Tiling scheme of the service. Only applies if the singleFusedMapCache property is YES.

Since
100

◆ tileServers

- (NSArray<NSURL*>*) tileServers
readnonatomiccopy

The tile servers, which are subdomains on a map service endpoint.

Since
100

◆ timeInfo

- (AGSServiceTimeInfo*) timeInfo
readnonatomicstrong

The time information of the data in the service.

Since
100

◆ unit

- (AGSUnit*) unit
readnonatomicstrong

The unit of measurement for geographic data available in the service.

Since
100

◆ unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON
readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns
NSDictionary containing the unknown JSON.
Since
100

◆ unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON
readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns
NSDictionary containing the unsupported JSON.
Since
100

◆ URL

- (NSURL*) URL
readnonatomicstrong

The URL of the ArcGIS map service.

Since
100