Class FeatureFenceParameters
Geotrigger fence data created from features.
Namespace: Esri.ArcGISRuntime.Geotriggers
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class FeatureFenceParameters : FenceParametersRemarks
The features that create a FeatureFenceParameters provide a set of geometries (and attributes) that define targets for the Geotrigger. For example, if the condition is "notify me when my position comes within 50 meters of one of my target areas", the fence data are "my target areas" and each Feature is one target area.
Create a FeatureFenceParameters using a FeatureTable. The features can have point, line, or polygon geometry. For points and lines, you must also supply a BufferDistance. Each feature in the table represents a single fence.
You can filter features using attributes or geometry by supplying a where clause. For example, you could further refine "my target areas" to be "my target areas that are open and are in California".
The number of features fetched by querying an online table is limited by the layer's MaxRecordCount. Service feature tables that support pagination (SupportsPagination) are not subject to the maximum feature count limit.
A FenceGeotrigger can also take into account floors within buildings. If the feature table used to create the FeatureFenceParameters is referenced by a FeatureLayer that is IFloorAware, and the LocationDataSource used to create the GeotriggerFeed includes Floor information, then fences will only be entered when they are intersected by a Location on the correct floor. If the fence or location data does not include valid floor information, the floor is ignored and the fence is entered when it is intersected by the location.
A floor aware feature layer or table must be part of a GeoModel that includes a valid GeoModelFloorDefinition. All layers and tables that are used by the floor definition are loaded when the GeotriggerMonitor is started.
A Location can contain floor property as part of AdditionalSourceProperties. This is populated automatically by IndoorsLocationDataSource, or can be supplied as part of your own implementation.
A GeotriggerMonitor accounts for changes to the FeatureTable while the geotrigger is active. Added, removed, or updated fence features trigger a notification by the geotrigger monitor when the updated feature meets or no longer meets the geotrigger condition.
Updates to the FeatureTable occur in the following situations:
- An edit (add, update, or delete) is submitted to the local feature table.
- User interactions, like performing a pan or zoom in a map or scene, request updates from an online feature table (ServiceFeatureTable) for the new visible extent.
- If RefreshInterval is set on a layer associated with the FeatureTable, feature fences are updated at the specified interval. For a ServiceFeatureTable, fence features requested from the server include features within the buffered visible extent as well as features near the current device location. This allows the geotrigger monitor to check fences both inside and outside of the current visible area.
-
Online feature fences are explicitly requested using
PopulateFromServiceAsync(QueryParameters, Boolean, IEnumerable<String>). Use
this method to control how and when feature fence updates are requested from a server. Setting the clearCache
parameter of this method to
trueclears fence features from the local feature table before repopulating with updated features from the server. This ensures that deleted features are recognized and that the geotrigger monitor sends exit notifications.
Dynamic feature fence capabilities are enabled for ServiceFeatureTable, GeodatabaseFeatureTable, and FeatureCollectionTable table types. They are disabled for all other table types and in the following circumstances:
- FeatureTable has a FeatureRequestMode set to OnInteractionNoCache.
- FeatureTable is part of a FeatureLayer that sets TilingMode to Disabled. For feature fences from a ServiceFeatureTable, EnabledWithFullResolutionWhenSupported is recommended for highest accuracy.
When saving new geotriggers into a web map, ensure all feature layers are assigned a unique Id. This ensures the saved FeatureTable is associated with the corresponding layer. When the saved Map and GeotriggersInfo are loaded, the layer and geotrigger will use the same FeatureTable.
Constructors
| Name | Description |
|---|---|
| FeatureFenceParameters(FeatureTable) | Initializes a new instance of the FeatureFenceParameters class using all of the features in
the |
| FeatureFenceParameters(FeatureTable, Double) | Initializes a new instance of the FeatureFenceParameters class using all of the features in
the |
Properties
| Name | Description |
|---|---|
| AreaOfInterest | Gets or sets the geometry that can be used to spatially filter fences. |
| FeatureTable | Gets the FeatureTable that contains the features to use in the FeatureFenceParameters. |
| WhereClause | Gets or sets a where clause that defines the features from the FeatureTable to use as fences. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.12 - 200.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.12 - 200.5 |
| Xamarin.Android | 100.12 - 100.15 |
| Xamarin.iOS | 100.12 - 100.15 |
| UWP | 100.12 - 200.5 |