react-native-background-geolocation icon indicating copy to clipboard operation
react-native-background-geolocation copied to clipboard

Missing template tags documentation

Open jdlourenco opened this issue 1 year ago • 0 comments

The library template tags documentation is missing the description of some tags: https://transistorsoft.github.io/react-native-background-geolocation/interfaces/config.html#template-tags

Your Environment

  • Plugin version: 4.14.5
  • Platform: iOS
  • OS version: 17.2
  • Device manufacturer / model: Samsung
  • React Native version (react-native -v): 0.71.4
  • Plugin config
{
        url: `${apiBaseUrl}geo/geofence/event`,
        geofenceTemplate:
          '{ "timestamp": "<%= timestamp %>", "uuid": "<%= uuid %>", "age": <%= age %>, "event": "<%= event %>", "odometer": <%= odometer %>, "geofence": { "identifier": "<%= geofence.identifier %>", "action": "<%= geofence.action %>" }, "coords":{ "latitude": <%= latitude %>, "longitude": <%= longitude %>, "accuracy": <%= accuracy %>, "altitude": <%= altitude %>, "altitude_accuracy": <%= altitude_accuracy %> }, "activity": { "type": "<%= activity.type %>", "confidence": <%= activity.confidence %> }, "is_mock": <%= mock %>, "is_moving": <%= is_moving %> }',
        autoSync: true,
        reset: false,
        geofenceModeHighAccuracy: highAccuracyMode, // <-- consumes more power; default is false.
        debug: true,
        logLevel: BackgroundGeolocation.LOG_LEVEL_VERBOSE,
        stopOnTerminate: false,
        startOnBoot: true,
        desiredAccuracy: accuracy,
        locationAuthorizationRequest: 'Always',
        backgroundPermissionRationale: {
          title: "Allow {applicationName} to access to this device's location in the background?",
          message:
            'In order to track your activity in the background, please enable {backgroundPermissionOptionLabel} location permission',
          positiveAction: 'Change to {backgroundPermissionOptionLabel}',
          negativeAction: 'Cancel',
        },
        locationAuthorizationAlert: {
          titleWhenNotEnabled: 'Hey! location services are not enabled',
          titleWhenOff: 'Hey! location services are off',
          instructions: "You must enable 'Always' in location services",
          cancelButton: 'Cancel',
          settingsButton: 'Settings',
        },
      },

Expected Behavior

The documentation should have the description of all template tag fields but at least the age tag is missing.

Actual Behavior

The documentation should have the description of all template tag fields, including the age tag.

Steps to Reproduce

Go to https://transistorsoft.github.io/react-native-background-geolocation/interfaces/config.html#template-tags and search for the age tag.

Context

Create a strongly type API endpoint to collect geofence events and it would be nice to be sure about the age field data type.

jdlourenco avatar Dec 29 '23 12:12 jdlourenco