addGeofences

Adds a geofence too look for.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"fences"	Array	The list of the geofences.	null
"query"	String	The table query	null
"queryParams"	Array	The list of the appended query parameters.	null
"table"	String	The database table.	null
"template"	String	Template to apply to the query result.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Add a geofence

Show ExampleHide Example

Add a geofence based on the data provided by the user.

{
  "type": "addGeofences",
  "params": {
    "table": "geofences",
    "query": "all",
    "template": "addGeofence"
  }
}

{
  "name": "addGeofence",
  "content": {
    "id": "{{id}}",
    "latitude": "{{latitude}}",
    "longitude": "{{longitude}}",
    "radius": "{{radius}}",
    "showWhileInBackground": false,
    "showOnceInSeconds": 10,
    "showOnceInSecondsEnter": 10,
    "showOnceInSecondsExit": 10,
    "maxAge": 3,
    "events": [
      {
        "type": "enterRegion",
        "actions": [
          {
            "type": "if",
            "params": {
              "condition": {
                "left": "{{enterNotification}}",
                "mode": "equals",
                "right": "true"
              }
            },
            "then": [
              {
                "type": "showMessage",
                "params": {
                  "title": "$lang(geofenece02Content09)$ {{name}}",
                  "text": "$lang(geofenece02Content10)$",
                  "asNotification": true
                }
              }
            ],
            "else": [
              {
                "type": "noAction"
              }
            ]
          }
        ]
      },
      {
        "type": "exitRegion",
        "actions": [
          {
            "type": "if",
            "params": {
              "condition": {
                "left": "{{exitNotification}}",
                "mode": "equals",
                "right": "true"
              }
            },
            "then": [
              {
                "type": "showMessage",
                "params": {
                  "title": "$lang(geofenece02Content11)$ {{name}}",
                  "text": "$lang(geofenece02Content12)$",
                  "asNotification": true
                }
              }
            ],
            "else": [
              {
                "type": "noAction"
              }
            ]
          }
        ]
      }
    ]
  }
}

The data is first stored in the geofences database table. The addGeofences action then retrieves the data from the database table and uses the specified template.