Hyper
The main entry point for the HyperTrack SDK
Types
The reason for why the SDK doesn't have a fresh location.
Geotag location with deviation from expected location in meters.
Order assigned to the worker
A group of orders.
Order event
Functions
Adds a new geotag with order status. Order status is used to identify the important moments during the fulfillment using custom labels (e.g clockIn, clockOut, login, accepted, started, arrived, completed, logout etc.). This provides the ability to filter and aggregate KPIs across geotags available through APIs and the Ops Views. Use geotags to mark a location at the current timestamp with custom metadata associated with this location.
Adds a new geotag with expected location and order status. Use geotags to mark a location at the current timestamp with custom metadata associated with this location. Order status is used to identify the important moments during the fulfillment using custom labels (e.g clockIn, clockOut, login, accepted, started, arrived, completed, logout etc.). This provides the ability to filter and aggregate KPIs across geotags available through APIs and the Ops Views. Expected location is used to calculate deviation distance of the actual location where the geotag was recorded from the expected place.
Requests one-time location update and returns the location once it is available, or error.
Subscribe to tracking errors
Subscribe to availability changes
Subscribe to tracking intent changes
Subscribe to location changes
Subscribe to changes in the orders assigned to the worker
Properties
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.