GeotriggerNotificationInfo Class

Geotrigger condition that has been met."> GeotriggerNotificationInfo Class | ArcGISQtCpp
  • GeotriggerNotificationInfo
  • class Esri::ArcGISRuntime::GeotriggerNotificationInfo

    Provides details about a Geotrigger condition that has been met. More...

    Header: #include <GeotriggerNotificationInfo.h>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object
    Inherited By:


    Public Functions

    virtual ~GeotriggerNotificationInfo() override
    QStringList actions() const
    QString feedEntityId() const
    Esri::ArcGISRuntime::Location feedLocation() const
    Esri::ArcGISRuntime::GeotriggerMonitor *geotriggerMonitor() const
    Esri::ArcGISRuntime::GeotriggerNotificationInfoType geotriggerNotificationInfoType() const
    QString message() const
    QVariantMap messageProperties() const

    Detailed Description

    A GeotriggerNotificationInfo is sent by a GeotriggerMonitor whenever the condition described by its Geotrigger is met. The Geotrigger also defines how the GeotriggerNotificationInfo should be displayed. For example, it describes what message should be displayed to the user.

    Member Function Documentation

    [override virtual] GeotriggerNotificationInfo::~GeotriggerNotificationInfo()


    [since Esri::ArcGISRuntime 100.14] QStringList GeotriggerNotificationInfo::actions() const

    Returns a set of strings describing recommended actions based on this notification.

    Optionally, use these strings to determine whether your app will perform custom behavior, such as showing messages or starting/stopping tracking. Note that there is no requirement to take any action when a notification is delivered, but these provide a way to understand the intention of the author of the Geotrigger. This property can be empty.

    These actions are the result of evaluating the Geotrigger::messageExpression for the specific objects that triggered this notification. If the expression returns a dictionary containing a list of strings with the key "actions", they are shown in this property.

    For example, if the Geotrigger::messageExpression evaluates to a dictionary of messageProperties containing the following key value pairs:

    • "message" with the string "Hello world"
    • "actions" with a list of action strings "startTracking","showMessage"

    ... then this property returns a list containing "startTracking" and "showMessage". The list of actions are simple strings so you can use them to control any custom action for your app.

    The author of a Geotrigger can supply a set of all the possible Geotrigger::requestedActions when defining the Geotrigger. This property returns a list of strings indicating the actions that should be taken by your app, based on this GeotriggerNotificationInfo.

    This function was introduced in Esri::ArcGISRuntime 100.14.

    [since Esri::ArcGISRuntime 100.13] QString GeotriggerNotificationInfo::feedEntityId() const

    Returns a unique ID for the entity within the feed that triggered the notification info.

    This property is consistent for all notifications for a given feed entity. For example, use this ID to count the number of sites a team member visits.

    If a feed uses an AbstractLocationDataSource, all location updates for that feed share the same ID.

    With a FenceGeotrigger, you can combine this property with the FenceGeotriggerNotificationInfo::fenceId to create an ID that groups all notifications for a given feed entity and a specific fence. For example, use a concatenation of the two properties to display a list of areas of interest that are currently occupied and the details of who has entered them.

    To group events by the geotrigger, use the Geotrigger::geotriggerId property.

    This function was introduced in Esri::ArcGISRuntime 100.13.

    See also FenceGeotriggerNotificationInfo::fenceId and Geotrigger::geotriggerId.

    Esri::ArcGISRuntime::Location GeotriggerNotificationInfo::feedLocation() const

    Returns a Location, received from the feed, that meets the GeotriggerMonitor condition.

    The Location is set if a LocationGeotriggerFeed was used to create the Geotrigger that the GeotriggerMonitor is monitoring. This allows you to access the position and meta-data from the feed, such as the horizontal accuracy, velocity, time stamp and other Location::additionalSourceProperties.

    Esri::ArcGISRuntime::GeotriggerMonitor *GeotriggerNotificationInfo::geotriggerMonitor() const

    Returns the GeotriggerMonitor that sent this notification.

    The GeotriggerMonitor evaluates a specific Geotrigger condition that has been met by this GeotriggerNotificationInfo. A single Geotrigger condition can result in multiple, repeat notifications.

    Use this property to interact directly with the GeotriggerMonitor. For example, if you no longer want to receive future notifications, you can call GeotriggerMonitor::stop.

    Esri::ArcGISRuntime::GeotriggerNotificationInfoType GeotriggerNotificationInfo::geotriggerNotificationInfoType() const

    Returns the type of geotrigger notification.

    The type for a specific GeotriggerNotificationInfo object. Returns -1 if an error occurs.

    QString GeotriggerNotificationInfo::message() const

    Returns a message that describes the notification.

    The notification message is the result of evaluating the Geotrigger::messageExpression for the specific feed and fence objects that triggered this notification. The message could be a hard-coded string or use attributes from an area of interest that was entered to display a custom message.

    For example, with a FenceGeotrigger, setting the Geotrigger::messageExpression property to:

    "You have entered " + $fencefeature.area_name

    would return the message "You have entered Area A", where "area_name" is an attribute field on the FenceGeotriggerNotificationInfo::fenceGeoElement.

    You can use this message to alert the user directly or in other business logic in your app.

    QVariantMap GeotriggerNotificationInfo::messageProperties() const

    Returns a dictionary of optional properties derived from the Geotrigger::messageExpression.

    Optionally, you can evaluate the ArcadeExpression to produce properties on top of the basic message. You can access this additional information via this dictionary.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.