-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #198 from Esri/Caleb/New-SetUpLocationDrivenGeotri…
…gers [New] Set up location-driven geotriggers
- Loading branch information
Showing
6 changed files
with
518 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
Shared/Samples/Set up location-driven geotriggers/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Set up location-driven geotriggers | ||
|
|
||
| Create a notification every time a given location data source has entered and/or exited a set of features or graphics. | ||
|
|
||
|  | ||
|
|
||
| ## Use case | ||
|
|
||
| Geotriggers can be used to notify users when they have entered or exited a geofence by monitoring a given set of features or graphics. They could be used to display contextual information to museum visitors about nearby exhibits, notify hikers when they have wandered off their desired trail, notify dispatchers when service workers arrive at a scene, or more. | ||
|
|
||
| ## How to use the sample | ||
|
|
||
| Observe a virtual walking tour of the Santa Barbara Botanic Garden. Information about the user's current Garden Section, as well as information about nearby points of interest within 10 meters will display or be removed from the UI when the user enters or exits the buffer of each feature. | ||
|
|
||
| ## How it works | ||
|
|
||
| 1. Create a `GeotriggerFeed` with a `LocationDataSource` object (in this case, a `SimulatedLocationDataSource`). | ||
| 2. Create a `FeatureFenceParameters` class from a `ServiceFeatureTable`, a buffer distance at which to monitor each feature, an Arcade Expression, and a name for the specific geotrigger. | ||
| 3. Create a `FenceGeotrigger` with the geotrigger feed, a `FenceGeotrigger.RuleType`, and the fence parameters. | ||
| 4. Create a `GeotriggerMonitor` with the fence geotrigger and call `GeotriggerMonitor.start()` to begin listening for events that meet the fence rule type. | ||
| 5. When the `notifications` emit, capture the `GeotriggerNotificationInfo`. | ||
| 6. For more information about the feature that triggered the notification, cast the `GeotriggerNotificationInfo` to a `FenceGeotriggerNotificationInfo` and call `FenceGeotriggerNotificationInfo.fenceGeoElement`. | ||
| 7. Depending on the `FenceGeotriggerNotificationInfo.fenceNotificationType` display or hide information on the UI from the `GeoElement`'s attributes. | ||
|
|
||
| ## Relevant API | ||
|
|
||
| * ArcadeExpression | ||
| * FeatureFenceParameters | ||
| * FenceGeotrigger | ||
| * FenceGeotrigger.RuleType | ||
| * FenceGeotriggerNotificationInfo | ||
| * GeoElement | ||
| * Geotrigger | ||
| * GeotriggerFeed | ||
| * GeotriggerMonitor | ||
| * GeotriggerNotificationInfo | ||
| * ServiceFeatureTable | ||
| * SimulatedLocationDataSource | ||
|
|
||
| ## About the data | ||
|
|
||
| This sample uses the [Santa Barbara Botanic Garden Geotriggers Sample](https://www.arcgis.com/home/item.html?id=6ab0e91dc39e478cae4f408e1a36a308) ArcGIS Online Web Map which includes a georeferenced map of the garden as well as select polygon and point features to denote garden sections and points of interest. Description text and attachment images in the feature layers were provided by the Santa Barbara Botanic Garden and more information can be found on the [Garden Sections & Displays](https://www.sbbg.org/explore-garden/garden-sections-displays) portion of their website. All assets are used with permission from the Santa Barbara Botanic Garden. For more information, visit the [Santa Barbara Botanic Garden](https://www.sbbg.org) website. | ||
|
|
||
| ## Tags | ||
|
|
||
| alert, arcade, fence, geofence, geotrigger, location, navigation, notification, notify, routing, trigger |
53 changes: 53 additions & 0 deletions
53
Shared/Samples/Set up location-driven geotriggers/README.metadata.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| { | ||
| "category": "Display information", | ||
| "description": "Create a notification every time a given location data source has entered and/or exited a set of features or graphics.", | ||
| "ignore": false, | ||
| "images": [ | ||
| "set-up-location-driven-geotriggers.png" | ||
| ], | ||
| "keywords": [ | ||
| "alert", | ||
| "arcade", | ||
| "fence", | ||
| "geofence", | ||
| "geotrigger", | ||
| "location", | ||
| "navigation", | ||
| "notification", | ||
| "notify", | ||
| "routing", | ||
| "trigger", | ||
| "ArcadeExpression", | ||
| "FeatureFenceParameters", | ||
| "FenceGeotrigger", | ||
| "FenceGeotrigger.RuleType", | ||
| "FenceGeotriggerNotificationInfo", | ||
| "GeoElement", | ||
| "Geotrigger", | ||
| "GeotriggerFeed", | ||
| "GeotriggerMonitor", | ||
| "GeotriggerNotificationInfo", | ||
| "ServiceFeatureTable", | ||
| "SimulatedLocationDataSource" | ||
| ], | ||
| "redirect_from": [], | ||
| "relevant_apis": [ | ||
| "ArcadeExpression", | ||
| "FeatureFenceParameters", | ||
| "FenceGeotrigger", | ||
| "FenceGeotrigger.RuleType", | ||
| "FenceGeotriggerNotificationInfo", | ||
| "GeoElement", | ||
| "Geotrigger", | ||
| "GeotriggerFeed", | ||
| "GeotriggerMonitor", | ||
| "GeotriggerNotificationInfo", | ||
| "ServiceFeatureTable", | ||
| "SimulatedLocationDataSource" | ||
| ], | ||
| "snippets": [ | ||
| "SetUpLocationDrivenGeotriggersView.swift", | ||
| "SetUpLocationDrivenGeotriggersView.Model.swift" | ||
| ], | ||
| "title": "Set up location-driven geotriggers" | ||
| } |
Oops, something went wrong.