ArcGIS Runtime SDK for iOS
100.15
|
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:
AGSGeotriggersInfo
from the AGSGeoModel::geotriggersInfo
property.AGSGeotriggersInfo
to populate the AGSGeotriggersInfo::geotriggers
array.AGSGeotrigger
in the array, check whether the AGSGeotrigger::feed
is of type AGSLocationGeotriggerFeed
.AGSLocationGeotriggerFeed::locationDataSource
to your AGSLocationDataSource
. For example, using the AGSLocationDisplay::dataSource
.AGSGeotriggerMonitor
for each AGSGeotrigger
you want to use.AGSGeotriggerMonitor
.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
.
Instance Methods | |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Properties | |
NSMutableArray< AGSGeotrigger * > * | geotriggers |
NSError * | loadError |
AGSLoadStatus | loadStatus |
|
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
- (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
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (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.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
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.
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. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload - (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.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf 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.
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. |
|
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.
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.