Class Geotrigger

    • Method Detail

      • getGeotriggerId

        public java.lang.String getGeotriggerId()
        Gets a unique ID for the Geotrigger.
        Returns:
        a unique ID for the Geotrigger
        Since:
        100.13.0
      • getName

        public java.lang.String getName()
        Gets the name of the Geotrigger.
        Returns:
        the name of the Geotrigger
        Since:
        100.12.0
      • setName

        public void setName​(java.lang.String name)
        Sets the name of the Geotrigger.
        Parameters:
        name - the name of the Geotrigger
        Throws:
        java.lang.IllegalArgumentException - if name is null
        Since:
        100.12.0
      • getRequestedActions

        public java.util.List<java.lang.String> getRequestedActions()
        Gets a list of strings indicating the set of requested actions when a notification is delivered.

        This property shows the full list of recommended actions that the Geotrigger author intends to be taken. Note that there is no requirement to take any action when a notification is delivered, but these provide a way to understand the Geotrigger author's intention. Use this property to:

        • Display the expected behavior of a Geotrigger to the user, prior to monitoring.
        • Check that your app supports the expected actions for the Geotrigger.
        This list of strings shows the full set of recommended actions for any notifications from this Geotrigger. Individual GeotriggerNotificationInfo events may include a subset of these actions. The specific actions for an individual notification event (for example, when a given fence is entered) are shown in GeotriggerNotificationInfo.getActions(). To populate the list of actions for a notification, the getMessageExpression() must return a dictionary with the key "actions", and a value showing the list of action strings.

        The list of actions are simple strings, so you can use them to control any custom action you wish your app to perform.

        Returns:
        a list of strings indicating the set of requested actions when a notification is delivered
        Since:
        100.14.0