ArcGIS Runtime SDK for iOS: Licensing
ArcGIS Runtime SDK for iOS  100.15
Licensing

Detailed Description

Functionality that requires Basic or Standard license for production deployment.

This page lists all the APIs that require a Basic or Standard license for production deployment. All remaining APIs not listed here require a Lite license for production deployment. No license is required for any APIs in Developer mode for testing.

Classes

class  AGSClosestFacilityTask
 A task to find facilities closest to an incident. More...
 
class  AGSENCCell
 An ENC Cell. More...
 
class  AGSENCExchangeSet
 An ENC exchange set. More...
 
class  AGSENCLayer
 A layer that displays ENC data. More...
 
class  AGSGeoElementLineOfSight
 Analysis of visibility along a line between two geo-elements. More...
 
class  AGSGeoElementViewshed
 Analysis of viewshed for a specified geo-element. More...
 
class  AGSGeoPackage
 A GeoPackage on disk. More...
 
class  AGSImageServiceRaster
 An instance of this class represents a raster that is retrieved from an ArcGIS image service. More...
 
class  AGSKMLDataset
 A KML dataset. More...
 
class  AGSKMLLayer
 A layer that can visualize KML data. More...
 
class  AGSLineOfSight
 Base class for all line-of-sight analysis. More...
 
class  AGSLocationLineOfSight
 Analysis of visibility along a line between two locations. More...
 
class  AGSLocationViewshed
 Analysis of viewshed for a specified location. More...
 
class  AGSMobileMapPackage
 A mobile map package. More...
 
class  AGSMosaicDatasetRaster
 A mosaic dataset raster. More...
 
class  AGSOfflineMapSyncJob
 A job to sync an offline map. More...
 
class  AGSRaster
 A raster dataset. More...
 
class  AGSRasterElevationSource
 An elevation source based on raster elevation data. More...
 
class  AGSServiceAreaTask
 A task to calculate service areas. More...
 
class  AGSShapefileFeatureTable
 A shapefile dataset containing geographic features or non-spatial records. More...
 
class  AGSSyncGeodatabaseJob
 A job to synchronize changes between a geodatabase and an ArcGIS Feature service. More...
 
class  AGSViewshed
 Base class for all viewshed analysis. More...
 

Functions

(id< AGSCancelable >) - AGSArcGISFeature::addAttachmentWithName:contentType:data:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::addFeature:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::addFeatures:completion:
 
(id< AGSCancelable >) - AGSPortalUser::addPortalItem:withContentParameters:toFolder:completion:
 
(id< AGSCancelable >) - AGSServiceFeatureTable::applyEditsWithCompletion:
 
(instancetype) + AGSClosestFacilityTask::closestFacilityTaskWithDatabaseName:networkName:
 
(instancetype) + AGSClosestFacilityTask::closestFacilityTaskWithDataset:
 
(instancetype) + AGSClosestFacilityTask::closestFacilityTaskWithFileURLToDatabase:networkName:
 
(id< AGSCancelable >) - AGSPortalUser::createFolder:completion:
 
(id< AGSCancelable >) - AGSArcGISFeature::deleteAttachment:completion:
 
(id< AGSCancelable >) - AGSArcGISFeature::deleteAttachments:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::deleteFeature:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::deleteFeatures:completion:
 
(id< AGSCancelable >) - AGSPortalUser::deleteFolder:completion:
 
(id< AGSCancelable >) - AGSPortalUser::deletePortalItem:completion:
 
(instancetype) + AGSENCCell::ENCCellWithFileURL:
 
(instancetype) + AGSENCExchangeSet::ENCExchangeSetWithFileURLs:
 
(instancetype) + AGSGeoPackage::geoPackageWithFileURL:
 
(instancetype) + AGSGeoPackage::geoPackageWithName:
 
(instancetype) - AGSClosestFacilityTask::initWithDatabaseName:networkName:
 
(instancetype) - AGSServiceAreaTask::initWithDatabaseName:networkName:
 
(instancetype) - AGSClosestFacilityTask::initWithDataset:
 
(instancetype) - AGSServiceAreaTask::initWithDataset:
 
(instancetype) - AGSENCCell::initWithFileURL:
 
(instancetype) - AGSGeoPackage::initWithFileURL:
 
(instancetype) - AGSMobileMapPackage::initWithFileURL:
 
(instancetype) - AGSRaster::initWithFileURL:
 
(instancetype) - AGSShapefileFeatureTable::initWithFileURL:
 
(instancetype) - AGSENCExchangeSet::initWithFileURLs:
 
(instancetype) - AGSClosestFacilityTask::initWithFileURLToDatabase:networkName:
 
(instancetype) - AGSServiceAreaTask::initWithFileURLToDatabase:networkName:
 
(instancetype) - AGSGeoPackage::initWithName:
 
(instancetype) - AGSKMLDataset::initWithName:
 
(instancetype) - AGSMobileMapPackage::initWithName:
 
(instancetype) - AGSShapefileFeatureTable::initWithName:
 
(instancetype) - AGSRaster::initWithName:extension:
 
(instancetype) - AGSRaster::initWithRasterFunction:
 
(instancetype) - AGSKMLDataset::initWithRootNode:
 
(instancetype) - AGSKMLDataset::initWithURL:
 
(instancetype) + AGSKMLDataset::KMLDatasetWithName:
 
(instancetype) + AGSKMLDataset::KMLDatasetWithRootNode:
 
(instancetype) + AGSKMLDataset::KMLDatasetWithURL:
 
(instancetype) + AGSMobileMapPackage::mobileMapPackageWithFileURL:
 
(instancetype) + AGSMobileMapPackage::mobileMapPackageWithName:
 
(id< AGSCancelable >) - AGSPortalUser::movePortalItem:toFolder:completion:
 
(id< AGSCancelable >) - AGSPortalUser::movePortalItems:toFolder:completion:
 
(AGSOfflineMapSyncJob *) - AGSOfflineMapSyncTask::offlineMapSyncJobWithParameters:
 
(instancetype) + AGSRaster::rasterWithFileURL:
 
(instancetype) + AGSRaster::rasterWithName:extension:
 
(instancetype) + AGSRaster::rasterWithRasterFunction:
 
(id< AGSCancelable >) - AGSFeatureCollection::saveAs:portal:tags:folder:itemDescription:thumbnail:completion:
 
(id< AGSCancelable >) - AGSMap::saveAs:portal:tags:folder:itemDescription:thumbnail:forceSaveToSupportedVersion:completion:
 
(id< AGSCancelable >) - AGSKMLNode::saveToFileURL:completion:
 
(id< AGSCancelable >) - AGSFeatureCollection::saveWithCompletion:
 
(id< AGSCancelable >) - AGSMap::saveWithForceSaveToSupportedVersion:completion:
 
(instancetype) + AGSServiceAreaTask::serviceAreaTaskWithDatabaseName:networkName:
 
(instancetype) + AGSServiceAreaTask::serviceAreaTaskWithDataset:
 
(instancetype) + AGSServiceAreaTask::serviceAreaTaskWithFileURLToDatabase:networkName:
 
(instancetype) + AGSShapefileFeatureTable::shapefileFeatureTableWithFileURL:
 
(instancetype) + AGSShapefileFeatureTable::shapefileFeatureTableWithName:
 
(id< AGSCancelable >) - AGSPortalItem::shareWithEveryone:org:completion:
 
(id< AGSCancelable >) - AGSPortalItem::shareWithGroups:completion:
 
(AGSSyncGeodatabaseJob *) - AGSGeodatabaseSyncTask::syncJobWithParameters:geodatabase:
 
(AGSSyncGeodatabaseJob *) - AGSGeodatabaseSyncTask::syncJobWithSyncDirection:rollbackOnFailure:geodatabase:
 
(id< AGSCancelable >) - AGSUtilityNetwork::traceWithParameters:completion:
 
(id< AGSCancelable >) - AGSRouteTracker::trackLocation:completion:
 
(id< AGSCancelable >) - AGSPortalItem::unshareWithCompletion:
 
(id< AGSCancelable >) - AGSPortalItem::unshareWithGroups:completion:
 
(id< AGSCancelable >) - AGSArcGISFeature::updateAttachment:name:contentType:data:completion:
 
(id< AGSCancelable >) - AGSPortalItem::updateData:completion:
 
(id< AGSCancelable >) - AGSPortalItem::updateDataWithJSON:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::updateFeature:completion:
 
(id< AGSCancelable >) - AGSFeatureTable::updateFeatures:completion:
 
(id< AGSCancelable >) - AGSItem::updateItemPropertiesWithCompletion:
 

Properties

NSMutableArray< AGSAnalysisOverlay * > * AGSSceneViewCommon::analysisOverlays
 

Function Documentation

◆ addAttachmentWithName:contentType:data:completion:

- (id<AGSCancelable>) addAttachmentWithName: (NSString *)  name
contentType: (NSString *)  contentType
data: (NSData *)  data
completion: (nullable void(^)(AGSAttachment *__nullable result, NSError *__nullable error))  completion 

Adds a new attachment for the feature

Parameters
nameof the attachment
contentTypeThe MIME type of the attachment
datarepresenting the attachment's content
completionblock that is invoked when operation completes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ addFeature:completion:

- (id<AGSCancelable>) addFeature: (AGSFeature *)  feature
completion: (nullable void(^)(NSError *__nullable error))  completion 

Add the specified feature to the dataset. Adding a feature that contains an AGSGeometry causes the geometry to become simplified. This may change a single part geometry to a multipart geometry, or round off X, Y, Z, and M coordinate values that are above the resolution set by the AGSSpatialReference.

Parameters
featureto add.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ addFeatures:completion:

- (id<AGSCancelable>) addFeatures: (NSArray< AGSFeature * > *)  features
completion: (nullable void(^)(NSError *__nullable error))  completion 

Add the specified features to the dataset. If one of the features fails, all will be rolled back. The error will contain the objectID of the feature that failed.

Parameters
featuresAn array of AGSFeature to add.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ addPortalItem:withContentParameters:toFolder:completion:

- (id<AGSCancelable>) addPortalItem: (AGSPortalItem *)  portalItem
withContentParameters: (nullable AGSPortalItemContentParameters *)  contentParameters
toFolder: (nullable AGSPortalFolder *)  folder
completion: (nullable void(^)(NSError *__nullable error))  completion 

Adds the specified item to the portal at the given folder.

Parameters
portalItemThe new item to be added to the portal.
contentParametersThe portal item content parameters for the item to be added.
folderThe folder in which to create the item. If nil is passed it will be added to the user's root folder.
completionblock that is invoked when operation finishes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ applyEditsWithCompletion:

- (id<AGSCancelable>) applyEditsWithCompletion: (nullable void(^)(NSArray< AGSFeatureEditResult * > *__nullable result, NSError *__nullable error))  completion

Apply the temporary edits in the local geodatabase to the service. Includes edits to a feature's attributes, geometry, and attachments.

applyEditsWithCompletion: is meant to be used for single table workflows or tables without geodatabase behavior (see below). If an edit on this table can cause an edit to another table due to geodatabase behavior, it is highly recommended to use applyEditsWithCompletion: (AGSServiceGeodatabase) instead to prevent data inconsistency, so that dependent edits are all applied or none are (if an error occurs).

For example, when tables have a composite relationship, applying the delete of a destination feature in a composite relationship deletion will only delete the destination feature on the server, therefore causing inconsistency in the data.

Areas which have geodatabase behavior:

  • Composite relationships
  • Annotation feature layers
  • Utility network association deletion semantics
  • Attribute rules
Parameters
completionA block that is executed when the operation finishes. The error argument will be populated if a problem is encountered with the entire applyEdits operation, for example, due to network disruption. Otherwise, the result array will contain AGSFeatureEditResult objects representing the result of each individual edit to a feature or an attachment.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ closestFacilityTaskWithDatabaseName:networkName:

+ (instancetype) closestFacilityTaskWithDatabaseName: (NSString *)  databaseName
networkName: (NSString *)  networkName 

Initialize the task with the name of a geodatabase containing a transportation network dataset, and the name of the dataset.

Parameters
databaseNamename of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension
networkNamename of the transportation network dataset within the geodatabase
Returns
a new closest facility task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ closestFacilityTaskWithDataset:

+ (instancetype) closestFacilityTaskWithDataset: (AGSTransportationNetworkDataset *)  dataset

Initialize the task with a reference to the transportation network dataset available for a map.

Parameters
datasettransportation network dataset to use
Returns
a new closest facility task
Since
100.2
See also
AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ closestFacilityTaskWithFileURLToDatabase:networkName:

+ (instancetype) closestFacilityTaskWithFileURLToDatabase: (NSURL *)  fileURLToDatabase
networkName: (NSString *)  networkName 

Initialize the task with a path to the geodatabase containing a transportation network dataset, and the name of the transportation network dataset.

Parameters
fileURLToDatabaseURL to the .geodatabase file on disk
networkNamename of the transportation network dataset within the geodatabase
Returns
a new closest facility task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ createFolder:completion:

- (id<AGSCancelable>) createFolder: (NSString *)  title
completion: (nullable void(^)(AGSPortalFolder *__nullable folder, NSError *__nullable error))  completion 

Creates a new folder with the given title in the user's root folder (nested folders are not supported). The 'folder' parameter in the completion block is the newly created AGSPortalFolder.

Parameters
titleThe title for the new folder.
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ deleteAttachment:completion:

- (id<AGSCancelable>) deleteAttachment: (AGSAttachment *)  attachment
completion: (nullable void(^)(NSError *__nullable error))  completion 

Delete an existing attachment of this feature.

Parameters
attachmentto be deleted
completionblock that is invoked when the operation completes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ deleteAttachments:completion:

- (id<AGSCancelable>) deleteAttachments: (NSArray< AGSAttachment * > *)  attachments
completion: (nullable void(^)(NSError *__nullable error))  completion 

Delete a set of existing attachments of this feature.

Parameters
attachmentsto be deleted as an array of AGSAttachment objects
completionblock that is invoked when the operation completes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ deleteFeature:completion:

- (id<AGSCancelable>) deleteFeature: (AGSFeature *)  feature
completion: (nullable void(^)(NSError *__nullable error))  completion 

Delete the specified feature in the dataset.

Parameters
featureto delete.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100
See also
- canDeleteFeature: to check if a particular feature can be deleted based on the source's ownership-based access control policies

◆ deleteFeatures:completion:

- (id<AGSCancelable>) deleteFeatures: (NSArray< AGSFeature * > *)  features
completion: (nullable void(^)(NSError *__nullable error))  completion 

Delete the specified features in the dataset. If one of the features fails, all will be rolled back. The error will contain the objectID of the feature that failed.

Parameters
featuresAn array of AGSFeature to delete.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100
See also
- canDeleteFeature: to check if a particular feature can be deleted based on the source's ownership-based access control policies

◆ deleteFolder:completion:

- (id<AGSCancelable>) deleteFolder: (AGSPortalFolder *)  folder
completion: (nullable void(^)(NSError *__nullable error))  completion 

Deletes the given folder from the portal. Deleting a folder also deletes all items that it contains. Note that you cannot delete a user's root folder, so the 'folder' parameter must be non-nil.

Parameters
folderThe folder to delete.
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ deletePortalItem:completion:

- (id<AGSCancelable>) deletePortalItem: (AGSPortalItem *)  portalItem
completion: (nullable void(^)(NSError *__nullable error))  completion 

Deletes an item from the portal.

Parameters
portalItemThe item to be deleted from the portal.
completionblock that is invoked when operation finishes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ ENCCellWithFileURL:

+ (instancetype) ENCCellWithFileURL: (NSURL *)  fileURL

Initialize the ENC cell with a S-57/ENC (extension .000) file.

Note
initWithDataset: is the preferred method of constructing an ENC cell delivered as part of an exchange set. When an ENC cell is constructed from the path directly, updates (*.001, *.002, etc.) that are part of the associated exchange set (if there is one) will not be applied.
Parameters
fileURLpath to S-57/ENC (extension .000) file.
Returns
Initialized ENC cell
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ ENCExchangeSetWithFileURLs:

+ (instancetype) ENCExchangeSetWithFileURLs: (NSArray< NSURL * > *)  fileURLs

Initialize the exchange set with paths to catalog files

Parameters
fileURLsArray containing paths to catalog (CATALOG.031) files
Returns
Initialized ENC exchange set
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ geoPackageWithFileURL:

+ (instancetype) geoPackageWithFileURL: (NSURL *)  fileURL

Initialze this object based on the given path to a local GeoPackage (.gpkg file) on disk.

Parameters
fileURLto existing GeoPackage on disk (including .gpkg file extension)
Since
100.2
Returns
A new GeoPackage
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ geoPackageWithName:

+ (instancetype) geoPackageWithName: (NSString *)  name

Initialize this object with the name of an existing GeoPackage, excluding the ".gpkg" extension, within the application bundle or shared documents directory.

Parameters
nameof the GeoPackage (excluding the .gpkg extension)
Returns
A new GeoPackage
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithDatabaseName:networkName: [1/2]

- (instancetype) initWithDatabaseName: (NSString *)  databaseName
networkName: (NSString *)  networkName 

Initialize the task with the name of a geodatabase containing a transportation network dataset, and the name of the dataset.

Parameters
databaseNamename of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension
networkNamename of the transportation network dataset within the geodatabase
Returns
a new closest facility task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithDatabaseName:networkName: [2/2]

- (instancetype) initWithDatabaseName: (NSString *)  databaseName
networkName: (NSString *)  networkName 

Initialize the task with the name of a geodatabase containing a transportation network dataset, and the name of the dataset.

Parameters
databaseNamename of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension
networkNamename of the transportation network dataset within the geodatabase
Returns
a new service area task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithDataset: [1/2]

- (instancetype) initWithDataset: (AGSTransportationNetworkDataset *)  dataset

Initialize the task with a reference to the transportation network dataset available for a map.

Parameters
datasettransportation network dataset to use
Returns
a new closest facility task
Since
100.2
See also
AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithDataset: [2/2]

- (instancetype) initWithDataset: (AGSTransportationNetworkDataset *)  dataset

Initialize the task with a reference to the transportation network dataset available for a map.

Parameters
datasettransportation network dataset to use
Returns
a new service area task
Since
100.2
See also
AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithFileURL: [1/5]

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Initialize the ENC cell with a S-57/ENC (extension .000) file.

Note
initWithDataset: is the preferred method of constructing an ENC cell delivered as part of an exchange set. When an ENC cell is constructed from the path directly, updates (*.001, *.002, etc.) that are part of the associated exchange set (if there is one) will not be applied.
Parameters
fileURLpath to S-57/ENC (extension .000) file.
Returns
Initialized ENC cell
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithFileURL: [2/5]

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Initialze this object based on the given path to a local GeoPackage (.gpkg file) on disk.

Parameters
fileURLto existing GeoPackage on disk (including .gpkg file extension)
Since
100.2
Returns
A new GeoPackage
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithFileURL: [3/5]

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Creates an object with the specified mobile map package (.mmpk file) on disk or a directory containing an unpacked mobile map package.

Parameters
fileURLto the mobile map package.
Since
100
License Restrictions:
This feature requires a StreetMap extension for production deployment when opening StreetMap Premium mobile map package . No license required in Developer mode for testing.

◆ initWithFileURL: [4/5]

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Initialize a raster with a path to the raster dataset on disk.

Parameters
fileURLto the local raster dataset on disk.
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithFileURL: [5/5]

- (instancetype) initWithFileURL: (NSURL *)  fileURL

Instantiates a featuretable based on the given path to a shapefile dataset on disk.

A shapefile dataset consists of at least three files (.shp, .shx, .dbf), and may include many others. Each of the component files of a shapefile must be smaller than 2 GB. When creating a shapefile feature table, the path must point to the .shp file and the associated .shx and .dbf files must be present at the same location.

Parameters
fileURLto existing shapefile (including .shp file extension)
Since
100.2
Returns
A new shapefile featuretable
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithFileURLs:

- (instancetype) initWithFileURLs: (NSArray< NSURL * > *)  fileURLs

Initialize the exchange set with paths to catalog files

Parameters
fileURLsArray containing paths to catalog (CATALOG.031) files
Returns
Initialized ENC exchange set
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithFileURLToDatabase:networkName: [1/2]

- (instancetype) initWithFileURLToDatabase: (NSURL *)  fileURLToDatabase
networkName: (NSString *)  networkName 

Initialize the task with a path to the geodatabase containing a transportation network dataset, and the name of the transportation network dataset.

Parameters
fileURLToDatabaseURL to the .geodatabase file on disk
networkNamename of the transportation network dataset within the geodatabase
Returns
a new closest facility task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithFileURLToDatabase:networkName: [2/2]

- (instancetype) initWithFileURLToDatabase: (NSURL *)  fileURLToDatabase
networkName: (NSString *)  networkName 

Initialize the task with a path to the geodatabase containing a transportation network dataset, and the name of the transportation network dataset.

Parameters
fileURLToDatabaseURL to the .geodatabase file on disk
networkNamename of the transportation network dataset within the geodatabase
Returns
a new service area task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ initWithName: [1/4]

- (instancetype) initWithName: (NSString *)  name

Initialize this object with the name of an existing GeoPackage, excluding the ".gpkg" extension, within the application bundle or shared documents directory.

Parameters
nameof the GeoPackage (excluding the .gpkg extension)
Returns
A new GeoPackage
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithName: [2/4]

- (instancetype) initWithName: (NSString *)  name

Initialize this dataset with a name of a KML or KMZ file, excluding the .kml or .kmz file extension, within the application bundle or shared documents directory.

Parameters
nameof the KML or KMZ file (excluding the .kml or .kmz file extension).
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.4

◆ initWithName: [3/4]

- (instancetype) initWithName: (NSString *)  name

Creates an object with the name of a mobile map package (.mmpk file), excluding the ".mmpk" extension, within the application bundle or shared documents directory.

Parameters
nameof the mobile map package (excluding the .mmpk extension)
Since
100
License Restrictions:
This feature requires a StreetMap extension for production deployment when opening StreetMap Premium mobile map package . No license required in Developer mode for testing.

◆ initWithName: [4/4]

- (instancetype) initWithName: (NSString *)  name

Initialize this object with the name of an existing shapefile, excluding the ".shp" extension, within the application bundle or shared documents directory.

A shapefile dataset consists of at least three files (.shp, .shx, .dbf), and may include many others. Each of the component files of a shapefile must be smaller than 2 GB. The .shp file and the associated .shx and .dbf files must be present at the same location.

Parameters
nameof the shapefile (excluding the .shp extension)
Returns
A new shapefile featuretable
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithName:extension:

- (instancetype) initWithName: (NSString *)  name
extension: (NSString *)  extension 

Initialize a raster with a name of a raster dataset within the application bundle or shared documents directory, and its file extension.

Parameters
nameof a raster dataset within the application bundle or shared documents directory.
extensionfile extension of the raster dataset
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithRasterFunction:

- (instancetype) initWithRasterFunction: (AGSRasterFunction *)  rasterFunction

Initialize a raster with a raster function.

Parameters
rasterFunctionwhose output is represented by this raster
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ initWithRootNode:

- (instancetype) initWithRootNode: (AGSKMLNode *)  rootNode

Initialize this dataset with the specified root node.

Parameters
rootNodeThe root KML node with which to create a dataset.
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.6

◆ initWithURL:

- (instancetype) initWithURL: (NSURL *)  URL

Initialize this dataset with URL to a KML/KMZ file on the web or on disk.

Parameters
URLto a KML/KMZ file on the web or on disk.
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.4

◆ KMLDatasetWithName:

+ (instancetype) KMLDatasetWithName: (NSString *)  name

Initialize this dataset with a name of a KML or KMZ file, excluding the .kml or .kmz file extension, within the application bundle or shared documents directory.

Parameters
nameof the KML or KMZ file (excluding the .kml or .kmz file extension).
Returns
A new kml dataset.
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.4

◆ KMLDatasetWithRootNode:

+ (instancetype) KMLDatasetWithRootNode: (AGSKMLNode *)  rootNode

Initialize this dataset with the specified root node.

Parameters
rootNodeThe root KML node with which to create a dataset.
Returns
A new kml dataset.
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.6

◆ KMLDatasetWithURL:

+ (instancetype) KMLDatasetWithURL: (NSURL *)  URL

Initialize this dataset with URL to a KML/KMZ file on the web or on disk.

Parameters
URLto a KML/KMZ file on the web or on disk.
License Restrictions:
This feature requires a Standard license for production deployment when using local .kml or .kmz file . No license required in Developer mode for testing.
Since
100.4

◆ mobileMapPackageWithFileURL:

+ (instancetype) mobileMapPackageWithFileURL: (NSURL *)  fileURL

Creates an object with the specified mobile map package (.mmpk file) on disk or a directory containing an unpacked mobile map package.

Parameters
fileURLThe file URL to the mobile map package.
Returns
A new mobile map package object.
Since
100
License Restrictions:
This feature requires a StreetMap extension for production deployment when opening StreetMap Premium mobile map package . No license required in Developer mode for testing.

◆ mobileMapPackageWithName:

+ (instancetype) mobileMapPackageWithName: (NSString *)  name

Creates an object with the name of a mobile map package (.mmpk file), excluding the ".mmpk" extension, within the application bundle or shared documents directory.

Parameters
nameThe name of the mobile map package (excluding the .mmpk extension).
Returns
A new mobile map package object.
Since
100
License Restrictions:
This feature requires a StreetMap extension for production deployment when opening StreetMap Premium mobile map package . No license required in Developer mode for testing.

◆ movePortalItem:toFolder:completion:

- (id<AGSCancelable>) movePortalItem: (AGSPortalItem *)  portalItem
toFolder: (nullable AGSPortalFolder *)  folder
completion: (nullable void(^)(NSError *__nullable error))  completion 

Moves a portal item to a new folder. Passing nil for the 'folder' parameter will move the item to the user's root folder.

Parameters
portalItemThe item to move.
folderThe folder to move the item to
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ movePortalItems:toFolder:completion:

- (id<AGSCancelable>) movePortalItems: (NSArray< AGSPortalItem * > *)  portalItems
toFolder: (nullable AGSPortalFolder *)  folder
completion: (nullable void(^)(NSDictionary< NSString *, NSError * > *__nullable moveErrors, NSError *__nullable error))  completion 

Moves an array of portal items to a new folder. Passing nil for the 'folder' parameter will move the item to the user's root folder. The moveErrors parameter in the completion block is a dictionary of itemIDs to errors that occurred when trying to move a particular portal item. The error parameter of the completion block is an overall error (like an HTTP error).

Parameters
portalItemsThe items to move. Items must be loaded and have an itemID.
folderThe folder to move the item to
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ offlineMapSyncJobWithParameters:

- (AGSOfflineMapSyncJob *) offlineMapSyncJobWithParameters: (AGSOfflineMapSyncParameters *)  parameters

Returns a job which can be used to synchronize the offline map. The result of the job will be an AGSOfflineMapSyncResult object.

The resulting job will synchronize an offline map's geodatabases with their originating services.

You should not execute more than one sync on a particular geodatabase at the same time.

This includes operations that export or import deltas from the local AGSGeodatabase:

Note
The job is dormant and needs to be explicitly started using startWithStatusHandler:completion: (AGSOfflineMapSyncJob).
Parameters
parametersThe parameters specifying how the map's feature layers and tables should be synced with the service.
Returns
A job representing the progress on the server. The result of the job will be an AGSOfflineMapSyncResult object.
Since
100.1
License Restrictions:
This feature requires a Basic license for production deployment when sync direction is Bidirectional or Upload with public feature services or when using a private feature service with any sync direction. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.

◆ rasterWithFileURL:

+ (instancetype) rasterWithFileURL: (NSURL *)  fileURL

Initialize a raster with a path to the raster dataset on disk.

Parameters
fileURLto the local raster dataset on disk.
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ rasterWithName:extension:

+ (instancetype) rasterWithName: (NSString *)  name
extension: (NSString *)  extension 

Initialize a raster with a name of a raster dataset within the application bundle or shared documents directory, and its file extension.

Parameters
nameof a raster dataset within the application bundle or shared documents directory.
extensionfile extension of the raster dataset
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ rasterWithRasterFunction:

+ (instancetype) rasterWithRasterFunction: (AGSRasterFunction *)  rasterFunction

Initialize a raster with a raster function.

Parameters
rasterFunctionwhose output is represented by this raster
Since
100
Returns
An initialized raster
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ saveAs:portal:tags:folder:itemDescription:thumbnail:completion:

- (id<AGSCancelable>) saveAs: (NSString *)  title
portal: (AGSPortal *)  portal
tags: (NSArray< NSString * > *)  tags
folder: (nullable AGSPortalFolder *)  folder
itemDescription: (NSString *)  itemDescription
thumbnail: (nullable AGSImage *)  thumbnail
completion: (nullable void(^)(NSError *__nullable error))  completion 

Saves this feature collection as a new feature collection item on the specified portal with the given title in the given folder. Once completed, the feature collection's item property will be populated with the new portal item. Note that if the feature collection already has a valid item property (either because the feature collection was created using an item or was previously saved), that property will be replaced with a new item, effecitively 'duplicating' the feature collection on the portal.

Parameters
titleThe title of the feature collection. Cannot be nil.
portalThe portal to save the feature collection to.
folderThe folder in which to save the feature collection. If nil is passed it will be added to the user's root folder.
tagsThe tags to be associated with the newly created portal item.
thumbnailThe thumbnail of the feature collection. The recommended thumbnail image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG with a maximum file size of 1 MB
itemDescriptionThe description of the feature collection.
completionThe block that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ saveAs:portal:tags:folder:itemDescription:thumbnail:forceSaveToSupportedVersion:completion:

- (id<AGSCancelable>) saveAs: (NSString *)  title
portal: (AGSPortal *)  portal
tags: (NSArray< NSString * > *)  tags
folder: (nullable AGSPortalFolder *)  folder
itemDescription: (NSString *)  itemDescription
thumbnail: (nullable AGSImage *)  thumbnail
forceSaveToSupportedVersion: (BOOL)  forceSaveToSupportedVersion
completion: (nullable void(^)(NSError *__nullable error))  completion 

Saves this map as a new web map on the specified portal with the given title in the given folder. Once completed, the map's item property will be populated with the new portal item. Note that if the map already has a valid item property (either because the map was created using an item or was previously saved), that property will be replaced with a new item, effecitively 'duplicating' the map on the portal.

Parameters
titleThe title of the map. Cannot be nil.
portalThe portal to save the map to.
tagsThe tags to be associated with the newly created portal item.
folderThe folder in which to save the map. If nil is passed it will be added to the user's root folder.
itemDescriptionThe description of the map.
thumbnailThe thumbnail of the map. The recommended thumbnail image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG with a maximum file size of 1 MB
forceSaveToSupportedVersionFlag to indicate whether the map should be saved to the supported web map version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If YES, unknown data will be removed and the map will be saved. If NO, the operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.
completionThe block that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ saveToFileURL:completion:

- (id<AGSCancelable>) saveToFileURL: (NSURL *)  fileURL
completion: (void(^)(NSError *__nullable error))  completion 

Saves the node and any referenced local files into a zipped KMZ archive. The node will be saved to a KMZ file to ensure that any referenced files are available locally when sharing the file with others.

  • If this method is called on a leaf node (e.g. AGSKMLPlacemark, AGSKMLGroundOverlay, etc), only that node and its referenced files will be saved.
  • If this method is called on container node (e.g. AGSKMLDocument, AGSKMLFolder), the node and all of its children and referenced files will be saved.
  • If this method is called on an AGSKMLNetworkLink, the link will be saved but the children will not. This is because the children will simply be refetched when the saved network link is loaded.

Saving referenced files will differ based on the type of reference.

  • For HTTP paths, the path will be saved as is but the referenced file will not be zipped into the archive, as it will simply be refetched when the new KMZ is loaded.
  • For relative paths, the path will be saved as is and the referenced file will be zipped relative to the root of the KMZ file.
  • For absolute paths, the path will be converted to a relative path, and the referenced file will be zipped into a "files" folder at the root of the KMZ file. For example, "/Users/icons/some_icon.png" would be converted to "files/some_icon.png" and stored at that location in the KMZ file.

The filename supports unicode characters as well as nested directories. It must be non-empty and there must not be an existing file located there.

Parameters
fileURLto which the node should be saved (including .kmz file extension)
completionblock that is invoked when the operation completes successfully or encounters an error
Returns
operation which can be canceled
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.
Since
100.6

◆ saveWithCompletion:

- (id<AGSCancelable>) saveWithCompletion: (nullable void(^)(NSError *__nullable error))  completion

Saves this feature collection back to the item it originated from. Upon completion, the item's data will have been updated with the feature collection. An error will occur if the feature collection does not have a valid item property. A feature collection has a valid item property if it was created using initWithItem:, or has been previously saved as a new item using saveAs:portal:tags:folder:itemDescription:thumbnail:completion:.

Warning
This will overwrite contents of the existing feature collection item.
Parameters
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ saveWithForceSaveToSupportedVersion:completion:

- (id<AGSCancelable>) saveWithForceSaveToSupportedVersion: (BOOL)  forceSaveToSupportedVersion
completion: (nullable void(^)(NSError *__nullable error))  completion 

Saves this map back to the item it originated from. Upon completion, the item's data will have been updated with the map. An error will occur if the map does not have a valid item property. A map has a valid item property if it was created using either initWithItem: or initWithURL:, or has been previously saved as a new item using saveAs:portal:tags:folder:itemDescription:thumbnail:forceSaveToSupportedVersion:completion:.

Warning
This will overwrite contents of the existing map item.
Parameters
forceSaveToSupportedVersionFlag to indicate whether the map should be saved to the supported web map version that the API supports (see system requirements). This may cause data loss as unknown data is not saved. If YES, unknown data will be removed and the map will be saved. If NO, the operation will fail if the map contains unknown data that will not be saved. This flag can be used to provide a warning to users that some map data may be lost when the map is saved.
completionblock that is invoked when operation finishes.
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ serviceAreaTaskWithDatabaseName:networkName:

+ (instancetype) serviceAreaTaskWithDatabaseName: (NSString *)  databaseName
networkName: (NSString *)  networkName 

Initialize the task with the name of a geodatabase containing a transportation network dataset, and the name of the dataset.

Parameters
databaseNamename of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension
networkNamename of the transportation network dataset within the geodatabase
Returns
a new service area task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ serviceAreaTaskWithDataset:

+ (instancetype) serviceAreaTaskWithDataset: (AGSTransportationNetworkDataset *)  dataset

Initialize the task with a reference to the transportation network dataset available for a map.

Parameters
datasettransportation network dataset to use
Returns
a new service area task
Since
100.2
See also
AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ serviceAreaTaskWithFileURLToDatabase:networkName:

+ (instancetype) serviceAreaTaskWithFileURLToDatabase: (NSURL *)  fileURLToDatabase
networkName: (NSString *)  networkName 

Initialize the task with a path to the geodatabase containing a transportation network dataset, and the name of the transportation network dataset.

Parameters
fileURLToDatabaseURL to the .geodatabase file on disk
networkNamename of the transportation network dataset within the geodatabase
Returns
a new service area task
Since
100.2
License Restrictions:
This feature requires a Analysis extension for production deployment. No license required in Developer mode for testing.

◆ shapefileFeatureTableWithFileURL:

+ (instancetype) shapefileFeatureTableWithFileURL: (NSURL *)  fileURL

Instantiates a featuretable based on the given path to a shapefile dataset on disk.

A shapefile dataset consists of at least three files (.shp, .shx, .dbf), and may include many others. Each of the component files of a shapefile must be smaller than 2 GB. When creating a shapefile feature table, the path must point to the .shp file and the associated .shx and .dbf files must be present at the same location.

Parameters
fileURLto existing shapefile (including .shp file extension)
Since
100.2
Returns
A new shapefile featuretable
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ shapefileFeatureTableWithName:

+ (instancetype) shapefileFeatureTableWithName: (NSString *)  name

Initialize this object with the name of an existing shapefile, excluding the ".shp" extension, within the application bundle or shared documents directory.

A shapefile dataset consists of at least three files (.shp, .shx, .dbf), and may include many others. Each of the component files of a shapefile must be smaller than 2 GB. The .shp file and the associated .shx and .dbf files must be present at the same location.

Parameters
nameof the shapefile (excluding the .shp extension)
Returns
A new shapefile featuretable
Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.

◆ shareWithEveryone:org:completion:

- (id<AGSCancelable>) shareWithEveryone: (BOOL)  everyone
org: (BOOL)  org
completion: (nullable void(^)(NSError *__nullable error))  completion 

Kicks off an operation which will share the item based on the given parameters. This method is used to share an item with everyone or just with the user's organization. If both 'everyone' and 'org' arguments are YES, the item will be shared with everyone (AGSPortalAccessPublic). If both 'everyone' and 'org' arguments are NO, the item will be made private, unless the item has been shared with one or more groups. In that case, the items 'access' will be set to AGSPortalAccessShared. The groups an item has been shared with are not affected by this method. The completion block is invoked when the operation completes successfully or if an error is encountered.

Parameters
everyoneA Boolean value that indicates whether the items should be shared with everyone (made public).
orgA boolean that denotes whether the items should be shared with the organization.
completionA block that is invoked when operation finishes.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ shareWithGroups:completion:

- (id<AGSCancelable>) shareWithGroups: (NSArray< AGSPortalGroup * > *)  groups
completion: (nullable void(^)(NSArray< AGSPortalGroup * > *__nullable excludedGroups, NSError *__nullable error))  completion 

Kicks off an operation which will share the item with the given groups. The completion block is invoked when the operation completes successfully or if an error is encountered. It's not necessary to load the AGSPortalGroup objects that are passed to this method.

Parameters
groupsAn array of portal groups (AGSPortalGroup objects) the item should be shared with.
completionA block that is invoked when operation finishes. The excludedGroups parameter is an array of group IDs representing the groups the item could not be shared with.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ syncJobWithParameters:geodatabase:

- (AGSSyncGeodatabaseJob*) syncJobWithParameters: (AGSSyncGeodatabaseParameters *)  parameters
geodatabase: (AGSGeodatabase *)  geodatabase 

Returns a job to synchronize a geodatabase back to a service.

For a successfully completed job, the job's result returns an array of AGSSyncLayerResult objects, typically the array is empty. If individual edits failed then the result array provides these errors grouped by each table using AGSSyncLayerResult instances which in turn contain each edit error.

You should not execute more than one sync on a particular geodatabase at the same time. This includes operations that export or import deltas from the local AGSGeodatabase:

Note
The job is dormant and needs to be explicitly started using startWithStatusHandler:completion: (AGSSyncGeodatabaseJob).
Parameters
parametersspecifying how data should be synchronized with the service.
geodatabasewhose data needs to be synchronized.
Returns
A job representing the progress on the server. The result of the job will be a list of AGSSyncLayerResult objects.
License Restrictions:
This feature requires a Basic license for production deployment when sync direction is Bidirectional or Upload with public feature services or when using a private feature service with any sync direction. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
Since
100

◆ syncJobWithSyncDirection:rollbackOnFailure:geodatabase:

- (AGSSyncGeodatabaseJob*) syncJobWithSyncDirection: (AGSSyncDirection syncDirection
rollbackOnFailure: (BOOL)  rollbackOnFailure
geodatabase: (AGSGeodatabase *)  geodatabase 

Returns a job to synchronize a geodatabase back to its service using the given sync direction and rollback on failure boolean value.

This method provides convenience over #syncJobWithParameters:geodatabase by not requiring a parameters object to be first created, and also by correctly applying the syncDirection to either the geodatabase as a whole or individually to each layer inside the geodatabase depending upon which sync model is used by the geodatabase. If the given sync direction is not compatible with the sync task's feature service, the returned job will fail.

You should not execute more than one sync on a particular geodatabase at the same time. This includes operations that export or import deltas from the local AGSGeodatabase:

Note
The job is dormant and needs to be explicitly started using startWithStatusHandler:completion: (AGSSyncGeodatabaseJob).
Parameters
syncDirectionto be used.
rollbackOnFailurewhether or not edits are rolled back if sync fails.
geodatabasewhose data needs to be synchronized.
Returns
A job representing the progress on the server. The result of the job will be a list of AGSSyncLayerResult objects.
License Restrictions:
This feature requires a Basic license for production deployment when sync direction is Bidirectional or Upload with public feature services or when using a private feature service with any sync direction. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
Since
100.3

◆ traceWithParameters:completion:

- (id<AGSCancelable>) traceWithParameters: (AGSUtilityTraceParameters *)  traceParameters
completion: (void(^)(NSArray< AGSUtilityTraceResult * > *__nullable result, NSError *__nullable error))  completion 

Begins a trace with the supplied AGSUtilityTraceParameters object.

This method returns an operation that supplies an array of AGSUtilityTraceResult objects when the utility network finishes the trace.

If the AGSUtilityTraceParameters::traceType property in the AGSUtilityTraceParameters object is a subnetwork-based trace, it must have an AGSUtilityDomainNetwork object set in the AGSUtilityTraceConfiguration object returned from the AGSUtilityTraceParameters::traceConfiguration property.

Parameters
traceParametersThe input arguments to the trace.
completionBlock that is invoked when the operation finishes. The result parameter is populated if the operation completed successfully, otherwise the error parameter is populated.
Returns
An operation which can be canceled.
Since
100.6
License Restrictions:
This feature requires a UtilityNetwork extension for production deployment. No license required in Developer mode for testing.

◆ trackLocation:completion:

- (id<AGSCancelable>) trackLocation: (AGSLocation *)  location
completion: (nullable void(^)(NSError *__nullable error))  completion 

Provides route tracking status relative to the provided location. The location generally comes from a GPS but may also be a simulated or manually entered location. It must have valid values for X and Y coordinates, speed (in meters per second), course (in degrees), and a timestamp. The delegate is called when the AGSTrackingStatus is updated for this location.

Parameters
locationA location used to evaluate status and progress along the route.
completionA block that is invoked when the operation finishes. The error parameter is populated on failure.
Returns
The operation which can be canceled.
See also
AGSLocation
Since
100.6
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.

◆ unshareWithCompletion:

- (id<AGSCancelable>) unshareWithCompletion: (nullable void(^)(NSError *__nullable error))  completion

Kicks off an operation which will unshare (make private) the item. The completion block is invoked when the operation completes successfully or if an error is encountered.

Parameters
completionA block that is invoked when operation finishes.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ unshareWithGroups:completion:

- (id<AGSCancelable>) unshareWithGroups: (NSArray< AGSPortalGroup * > *)  groups
completion: (nullable void(^)(NSArray< AGSPortalGroup * > *__nullable excludedGroups, NSError *__nullable error))  completion 

Kicks off an operation which will unshare the item with the given groups. The completion block is invoked when the operation completes successfully or if an error is encountered. It's not necessary to load the AGSPortalGroup objects that are passed to this method.

Parameters
groupsAn array of portal groups (AGSPortalGroup objects) the item should be unshared with.
completionA block that is invoked when operation finishes. The excludedGroups parameter is an array of group IDs representing the groups the item could not be unshared with.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ updateAttachment:name:contentType:data:completion:

- (id<AGSCancelable>) updateAttachment: (AGSAttachment *)  attachment
name: (NSString *)  name
contentType: (NSString *)  contentType
data: (NSData *)  data
completion: (nullable void(^)(NSError *__nullable error))  completion 

Update an existing attachment of the feature

Parameters
attachmentThe attachment to update
nameThe new name of the attachment
contentTypeThe new MIME type
dataThe new data
completionblock that is invoked when the operation completes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100

◆ updateData:completion:

- (id<AGSCancelable>) updateData: (NSData *)  data
completion: (nullable void(^)(NSError *__nullable error))  completion 

Kicks off an operation to update the file for the item on the portal. The completion block is invoked when the operation completes successfully or if an error is encountered. This method is applicable for portal items that represent a static file, such as a shapefile, CSV, etc.

Parameters
dataThe binary data with which to update the portal item.
completionA block that is invoked when operation finishes.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ updateDataWithJSON:completion:

- (id<AGSCancelable>) updateDataWithJSON: (id)  json
completion: (nullable void(^)(NSError *__nullable error))  completion 

Kicks off an operation to update the JSON data for the item on the portal. The completion block is invoked when the operation completes successfully or if an error is encountered. This method is applicable for portal items that use JSON representation, such as web map, feature collection, etc.

Parameters
jsonThe JSON data with which to update the portal item.
completionA block that is invoked when operation finishes.
Returns
An operation which can be canceled.
License Restrictions:
This feature requires a Basic license for production deployment. No license required in Developer mode for testing.
Since
100

◆ updateFeature:completion:

- (id<AGSCancelable>) updateFeature: (AGSFeature *)  feature
completion: (nullable void(^)(NSError *__nullable error))  completion 

Update the specified feature in the dataset. Updating a feature that contains an AGSGeometry causes the geometry to become simplified. This may change a single part geometry to a multipart geometry, or round off X, Y, Z, and M coordinate values that are above the resolution set by the AGSSpatialReference.

Parameters
featureto update.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100
See also
- canUpdateFeature: to check if a particular feature can be updated based on the source's ownership-based access control policies

◆ updateFeatures:completion:

- (id<AGSCancelable>) updateFeatures: (NSArray< AGSFeature * > *)  features
completion: (nullable void(^)(NSError *__nullable error))  completion 

Update the specified features in the dataset. If one of the features fails, all will be rolled back. The error will contain the objectID of the feature that failed.

Parameters
featuresAn array of AGSFeature to update.
completionblock that is invoked when the operation is complete
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when editing a local mobile geodatabase or a private feature service. "Public" feature services means services hosted on the Internet and available anonymously (not secured). "Private" includes all other scenarios such as feature services hosted on a local network within an enterprise or feature services hosted on the Internet but secured . No license required in Developer mode for testing.
See also
AGSFeatureServiceSessionType
Since
100
See also
- canUpdateFeature: to check if a particular feature can be updated based on the source's ownership-based access control policies

◆ updateItemPropertiesWithCompletion:

- (id<AGSCancelable>) updateItemPropertiesWithCompletion: (nullable void(^)(NSError *__nullable error))  completion

Kicks off an operation to update the item's properties on the portal or in a file on disk. The completion block is invoked when the operation completes successfully or if an error is encountered.

Updating properties can be only done for local items that are unpacked. For example a mobile map package file (.mmpk) can be unpacked using AGSMobileMapPackage::unpackMobileMapPackageAtFileURL:outputDirectory:completion. Once unpacked local items within the package can be updated see AGSMobileMapPackage::item and for any maps use AGSGeoModel::bookmarks. Like packages, the local item available from an item resource cache can be updated. This is accessed with AGSItemResourceCache::item. If the package is not unpacked, an error is returned in the completion block.

Parameters
completionblock that is invoked when operation finishes
Returns
operation which can be canceled
License Restrictions:
This feature requires a Basic license for production deployment when using a portal item . No license required in Developer mode for testing.
Since
100.4

Properties

◆ analysisOverlays

- (NSMutableArray<AGSAnalysisOverlay *>*) analysisOverlays
readnonatomicstrong

A collection of analysis overlays that render the results of visual analysis on the scene view.

Since
100.2
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.