Class HyperTrack

Adds a new geotag. Check Shift tracking and Clock In/Out tagging docs to learn how to use Order handle and Order status params.

Adds a new geotag with expected location. Check Shift tracking and Clock In/Out tagging docs to learn how to use Order handle and Order status params.

Deprecated

Adds a new geotag

Deprecated

Adds a new geotag with expected location

If disallowed, the HyperTrack platform will display and outage if mocked location is detected.

Returns a string that is used to uniquely identify the device

Returns a list of errors that blocks SDK from tracking

Reflects availability of the device for the Nearby search

Reflects the tracking intent for the device

Reflects the current location of the user or an outage reason

Gets the metadata that is set for the device

Gets the name that is set for the device

Gets the active orders for the worker. The orders are sorted with the ordering in which the worker should complete them.

A primary identifier that uniquely identifies the worker outside of HyperTrack. Example: email, phone number, database id It is usually obtained and set when the worker logs into the app. Set it to an empty string "" when the worker logs out of the app to un-bind the device from the worker and avoid unintentional tracking.

Requests one-time location update and returns the location once it is available, or error.

Only one locate subscription can be active at a time. If you re-subscribe, the old EmitterSubscription will be automaticaly removed.

This method will start location tracking if called, and will stop it when the location is received or the subscription is cancelled. If any other tracking intent is present (e.g. isAvailable is set to true), the tracking will not be stopped.

Example

const subscription = HyperTrack.locate(location => {
 ...
})

// to unsubscribe
subscription.remove()
Copy

Allows mocking location data.

Check the Test with mock locations guide for more information.

To avoid issues related to race conditions in your code use this API only if modifying the compiled HyperTrackAllowMockLocation AndroidManifest.xml/Info.plist value is insufficient for your needs. Example: if for some reason you aren't able to recompile with HyperTrackAllowMockLocation set to YES/true for your prod app QA mock location tests and need to set up the value in runtime.

Sets the availability of the device for the Nearby search

Sets the tracking intent for the device

Sets the metadata for the device

Sets the name for the device

A primary identifier that uniquely identifies the worker outside of HyperTrack. Example: email, phone number, database id It is usually obtained and set when the worker logs into the app. Set it to an empty string "" when the worker logs out of the app to un-bind the device from the worker and avoid unintentional tracking.

Subscribe to tracking errors

Example

const subscription = HyperTrack.subscribeToErrors(errors => {
  errors.forEach(error => {
    // ... error
  })
})

// later, to stop listening
subscription.remove()
Copy

Subscribe to availability changes

Example

const subscription = HyperTrack.subscribeToIsAvailable(isAvailable => {
  if (isAvailable) {
    // ... ready to go
  }
})

// later, to stop listening
subscription.remove()
Copy

Subscribe to tracking intent changes

Example

const subscription = HyperTrack.subscribeToIsTracking(isTracking => {
  if (isTracking) {
    // ... ready to go
  }
})

// later, to stop listening
subscription.remove()
Copy

Subscribe to location changes

Example

const subscription = HyperTrack.subscribeToLocation(location => {
  ...
})

// later, to stop listening
subscription.remove()
Copy

Subscribe to changes in the orders assigned to the worker

Example

const subscription = HyperTrack.subscribeToOrders(orders => {
  ...
})

// later, to stop listening
subscription.remove()
Copy