Description

A task to compute routes and turn-by-turn directions.

Instances of this class represent a task used to compute routes and turn-by-turn directions. It allows you to find a variety of routes between any given locations - the quickest, shortest, most scenic, and so on. The route returned depends on the impedance chosen by you. For example, if the impedance is time, then the best route is the quickest route. Hence, the best route can be defined as the route that has the lowest impedance.

The task can be created for an ArcGIS Network Analyst service hosted in the cloud on ArcGIS Online or on-premises with ArcGIS Server. The task can also be created for a transportation network dataset stored locally on the device in which case it can used even when the device has no network connectivity.

Since: 100

Inheritance diagram for AGSRouteTask:

Instance Methods
(void)	- cancelLoad

(id< AGSCancelable >)	- defaultRouteParametersWithCompletion:

(void)	- doCancelLoading

(void)	- doStartLoading:

(instancetype)	- initWithDatabaseName:networkName:

(instancetype)	- initWithDataset:

(instancetype)	- initWithFileURLToDatabase:networkName:

(instancetype)	- initWithURL:

(void)	- loadDidFinishWithError:

(void)	- loadWithCompletion:

(void)	- onLoadStatusChanged

(void)	- retryLoadWithCompletion:

(id< AGSCancelable >)	- routeParametersWithFeatureCollection:completion:

(id< AGSCancelable >)	- routeParametersWithPortalItem:completion:

(AGSRouteTaskInfo *)	- routeTaskInfo

(id< AGSCancelable >)	- solveRouteWithParameters:completion:

Class Methods
(id< AGSCancelable >)	+ routeResultWithFeatureCollection:completion:

(id< AGSCancelable >)	+ routeResultWithPortalItem:completion:

(instancetype)	+ routeTaskWithDatabaseName:networkName:

(instancetype)	+ routeTaskWithDataset:

(instancetype)	+ routeTaskWithFileURLToDatabase:networkName:

(instancetype)	+ routeTaskWithURL:

Properties
NSString *	APIKey

AGSCredential *	credential

NSError *	loadError

AGSLoadStatus	loadStatus

AGSRequestConfiguration *	requestConfiguration

AGSTransportationNetworkDataset *	transportationNetworkDataset

NSURL *	URL

Method Documentation

◆ cancelLoad

- (void) cancelLoad

requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since: 100

◆ defaultRouteParametersWithCompletion:

- (id<AGSCancelable>) defaultRouteParametersWithCompletion: (void(^)(AGSRouteParameters *__nullable routeParams, NSError *__nullable error)) completion

A convenience method to get properly initialized parameters for computing a route. The parameters are initialized with default values based on the routeTaskInfo property.

Parameters

completion block that is invoked when the operation completes. The route parameters are populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL) retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters

retrying flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ initWithDatabaseName:networkName:

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

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

Parameters

databaseName	name of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension.
networkName	name of the transportation network dataset within the geodatabase.

Since: 100

◆ initWithDataset:

- (instancetype) initWithDataset: (AGSTransportationNetworkDataset *) dataset

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

Parameters

dataset transportation network dataset to use.

Since: 100

See also: AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.

◆ initWithFileURLToDatabase:networkName:

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

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

Parameters

fileURLToDatabase	URL to the .geodatabase file on disk.
networkName	name of the transportation network dataset within the geodatabase.

Since: 100

◆ initWithURL:

- (instancetype) initWithURL: (NSURL *) URL

Initializes the task with a URL to a route layer in an ArcGIS Network Analyst service. The service may be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS Server.

Parameters

URL	to a route layer in an ArcGIS Network Analyst service. For example, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route.

Since: 100

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *) error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

See also: - cancelLoad to cancel loading; - retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since: 100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error)) completion

requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
the server was down earlier when it failed and you want to retry
the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters

completion block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.

Note: The completion block is always invoked on the main thread.

Since: 100

◆ routeParametersWithFeatureCollection:completion:

- (id<AGSCancelable>) routeParametersWithFeatureCollection:	(AGSFeatureCollection *)	featureCollection
completion:	(void(^)(AGSRouteParameters __nullable routeParams, NSError __nullable error))	completion

A convenience method to get properly initialized parameters for computing a route. The parameters are initialized with default values based on the routeTaskInfo property, and every feature in the provided feature collection is added as a stop along the desired route.

Parameters

featureCollection	containing the stops.
completion	block that is invoked when the operation completes. The route parameters are populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100

◆ routeParametersWithPortalItem:completion:

- (id<AGSCancelable>) routeParametersWithPortalItem:	(AGSPortalItem *)	portalItem
completion:	(void(^)(AGSRouteParameters __nullable routeParams, NSError __nullable error))	completion

A convenience method to get properly initialized parameters for computing a route similar to the one in the portal item. The item's type must be AGSPortalItemTypeFeatureCollection and the item must represent a route layer (i.e the item's typeKeywords must contain "Route Layer"). The parameters are initialized with default values based on the routeTaskInfo property, and every feature in the provided feature collection is added as a stop along the desired route.

Parameters

portalItem	representing a feature collection that contains stops, route info, and barriers tables. Stops table is required.
completion	block that is invoked when the operation completes. The route parameters are populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100.3

◆ routeResultWithFeatureCollection:completion:

+ (id<AGSCancelable>) routeResultWithFeatureCollection:	(AGSFeatureCollection *)	featureCollection
completion:	(void(^)(AGSRouteResult __nullable routeResult, NSError __nullable error))	completion

Imports a pre-planned route result from a feature collection.

Parameters

featureCollection	containing a route result.
completion	block that is invoked when the operation completes. The route result is populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100.4

◆ routeResultWithPortalItem:completion:

+ (id<AGSCancelable>) routeResultWithPortalItem:	(AGSPortalItem *)	portalItem
completion:	(void(^)(AGSRouteResult __nullable routeResult, NSError __nullable error))	completion

Imports a pre-planned route result from a portal item. The item's type must be AGSPortalItemTypeFeatureCollection and the item must represent a route layer (i.e the item's typeKeywords must contain "Route Layer").

Parameters

portalItem	representing a feature collection containing a route result.
completion	block that is invoked when the operation completes. The route result is populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100.3

◆ routeTaskInfo

- (AGSRouteTaskInfo*) routeTaskInfo

Metadata about the ArcGIS Network Analyst service or transportation network dataset being used by the task.

Since: 100

◆ routeTaskWithDatabaseName:networkName:

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

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

Parameters

databaseName	name of the geodatabase file (within the application bundle or shared documents directory) without the .geodatabase file extension.
networkName	name of the transportation network dataset within the geodatabase.

Returns: A new route task.

Since: 100

◆ routeTaskWithDataset:

+ (instancetype) routeTaskWithDataset: (AGSTransportationNetworkDataset *) dataset

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

Parameters

dataset transportation network dataset to use.

Returns: A new route task.

Since: 100

See also: AGSGeoModel::transportationNetworks to get a reference to the transportation network datasets available for a map.

◆ routeTaskWithFileURLToDatabase:networkName:

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

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

Parameters

fileURLToDatabase	URL to the .geodatabase file on disk.
networkName	name of the transportation network dataset within the geodatabase.

Returns: A new route task.

Since: 100

◆ routeTaskWithURL:

+ (instancetype) routeTaskWithURL: (NSURL *) URL

Creates a task with a URL to a route layer in an ArcGIS Network Analyst service. The service may be hosted in the cloud on ArcGIS Online or on-premises with ArcGIS Server.

Parameters

URL	to a route layer in an ArcGIS Network Analyst service. For example, http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route.

Returns: A new route task.

Since: 100

◆ solveRouteWithParameters:completion:

- (id<AGSCancelable>) solveRouteWithParameters:	(AGSRouteParameters *)	routeParameters
completion:	(void(^)(AGSRouteResult __nullable routeResult, NSError __nullable error))	completion

Computes routes based on the provided route parameters.

Parameters

routeParameters	based on which routes should be computed.
completion	block that is invoked when the operation completes. The result is populated if the operation succeeds, else the error is populated if the operation fails.

Since: 100

Property Documentation

◆ APIKey

- (NSString*) APIKey

readwriterequirednonatomiccopyinherited

The 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.

In addition to setting an API key at a global level for your application using the AGSArcGISRuntimeEnvironment::APIKey property, you can set an AGSAPIKeyResource::APIKey property on any ArcGIS Runtime class that implements AGSAPIKeyResource. When you set an individual AGSAPIKeyResource::APIKey property on an AGSAPIKeyResource it will override the default key at the global level (on the AGSArcGISRuntimeEnvironment::APIKey property, in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app. Classes that expose an API key property by implementing AGSAPIKeyResource include:

◆ credential

- (AGSCredential*) credential

readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since: 100

◆ loadError

- (NSError*) loadError

readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since: 100

◆ loadStatus

- (AGSLoadStatus) loadStatus

readrequirednonatomicassigninherited

Status of the load operation.

Since: 100

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration

readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since: 100

◆ transportationNetworkDataset

- (AGSTransportationNetworkDataset*) transportationNetworkDataset

readnonatomicstrong

The transportation network dataset being used by this task. Will be nil if the task is using a service instead of a local geodatabase.

Since: 100

◆ URL

- (NSURL*) URL

readrequirednonatomicstronginherited

The URL of the remote resource.

Since: 100

Description

Instance Methods

Class Methods

Properties

Method Documentation

◆ cancelLoad

◆ defaultRouteParametersWithCompletion:

◆ doCancelLoading

◆ doStartLoading:

◆ initWithDatabaseName:networkName:

◆ initWithDataset:

◆ initWithFileURLToDatabase:networkName:

◆ initWithURL:

◆ loadDidFinishWithError:

◆ loadWithCompletion:

◆ onLoadStatusChanged

◆ retryLoadWithCompletion:

◆ routeParametersWithFeatureCollection:completion:

◆ routeParametersWithPortalItem:completion:

◆ routeResultWithFeatureCollection:completion:

◆ routeResultWithPortalItem:completion:

◆ routeTaskInfo

◆ routeTaskWithDatabaseName:networkName:

◆ routeTaskWithDataset:

◆ routeTaskWithFileURLToDatabase:networkName:

◆ routeTaskWithURL:

◆ solveRouteWithParameters:completion:

Property Documentation

◆ APIKey

◆ credential

◆ loadError

◆ loadStatus

◆ requestConfiguration

◆ transportationNetworkDataset

◆ URL