AGSGeotriggersInfo Class Reference

Description

Presents information on an array of AGSGeotrigger objects defined for an AGSGeoModel.

The author of an AGSMap or an AGSScene can optionally specify one or more AGSGeotrigger conditions to be monitored when using the data. Once this type is loaded, review the list of AGSGeotriggersInfo::geotriggers and create an AGSGeotriggerMonitor to monitor each.

When an AGSGeotrigger is defined with an AGSGeotriggerFeed of type AGSLocationGeotriggerFeed, you must supply an AGSLocationDataSource to provide your device location. The general workflow is as follows:

• Get the AGSGeotriggersInfo from the AGSGeoModel::geotriggersInfo property.

• Load the AGSGeotriggersInfo to populate the AGSGeotriggersInfo::geotriggers array.

• For each AGSGeotrigger in the array, check whether the AGSGeotrigger::feed is of type AGSLocationGeotriggerFeed.

• Set the AGSLocationGeotriggerFeed::locationDataSource to your AGSLocationDataSource. For example, using the AGSLocationDisplay::dataSource.

• Create an AGSGeotriggerMonitor for each AGSGeotrigger you want to use.

• Connect to notifications sent by the AGSGeotriggerMonitor.

• Call startWithCompletion: (AGSGeotriggerMonitor) to begin monitoring.

Geotriggers can also take into account floors within buildings. If the AGSGeotriggersInfo is defined as part of an AGSGeoModel that includes a valid AGSGeoModelFloorDefinition, then the list of AGSGeotriggersInfo::geotriggers can take floor information into account. All layers and tables that are used by the floor definition are loaded when a floor aware AGSGeotriggerMonitor is started. To take floors into account when monitoring geotriggers, use an AGSLocationDataSource that includes floor details, such as the AGSIndoorsLocationDataSource.

Since

100.14

Inheritance diagram for AGSGeotriggersInfo:

Instance Methods
(void)	- cancelLoad
(void)	- doCancelLoading
(void)	- doStartLoading:
(void)	- loadDidFinishWithError:
(void)	- loadWithCompletion:
(void)	- onLoadStatusChanged
(void)	- retryLoadWithCompletion:

Properties
NSMutableArray< AGSGeotrigger * > *	geotriggers
NSError *	loadError
AGSLoadStatus	loadStatus

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

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

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:

1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
2. the server was down earlier when it failed and you want to retry
3. 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

Property Documentation

geotriggers

- (NSMutableArray<AGSGeotrigger *>*) geotriggers

readnonatomicstrong

The array of AGSGeotrigger objects defined for an AGSGeoModel.

This list is populated with AGSGeotrigger conditions defined by the author of the map or scene when the AGSGeotriggersInfo is AGSLoadStatusLoaded. If no geotriggers are defined, this list will remain empty.

You can add your own geotriggers to this property but be aware that when you save the map or scene any AGSGeotrigger objects that reference local data (for example an AGSGraphicsOverlayFenceParameters) will be omitted.

Since

100.14

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