locationTemplate property

Optional custom template for rendering location JSON request data in HTTP requests.

The locationTemplate will be evaluated for variables using Ruby erb-style tags:

<%= variable_name %>

See also:

• HTTP Guide at HttpConfig.
• PersistenceConfig.geofenceTemplate
• HttpConfig.rootProperty

BackgroundGeolocation.ready(Config(
  persistence: PersistenceConfig(
    locationTemplate: '{"lat":<%= latitude %>,"lng":<%= longitude %>,"event":"<%= event %>",isMoving:<%= isMoving %>}',
  )
));

// Or use a compact [Array] template!
  persistence: PersistenceConfig(
    locationTemplate: '[<%=latitude%>, <%=longitude%>, "<%=event%>", <%=is_moving%>]'
  ),
));

Warning: quoting String data.

The SDK does not automatically apply double-quotes around String data. The SDK will attempt to JSON encode your template exactly as you're configured.

The following will generate an error:

BackgroundGeolocation.ready(Config(
  persistence: PersistenceConfig(
    locationTemplate: '{"timestamp": <%= timestamp %>}'
  )
));

Since the template-tag timestamp renders a string, the rendered String will look like this:

{"timestamp": 2018-01-01T12:01:01.123Z}

The correct locationTemplate is:

BackgroundGeolocation.ready(Config(
  persistence: PersistenceConfig(
    locationTemplate: '{"timestamp": "<%= timestamp %>"}'
  )
));

{"timestamp": "2018-01-01T12:01:01.123Z"}

Configured PersistenceConfig.extras:

If you've configured PersistenceConfig.extras, these key-value pairs will be merged directly onto your location data. For example:

BackgroundGeolocation.ready(Config(
  http: HttpConfig(
    rRootProperty: 'data'
  ),
  persistence: PersistenceConfig(
    locationTemplate: '{"lat":<%= latitude %>,"lng":<%= longitude %>}',
    extras: {
      "foo": "bar"
    }
  )
))

Will result in JSON:

{
    "data": {
        "lat":23.23232323,
        "lng":37.37373737,
        "foo":"bar"
    }
}

Template Tags