Hyper
The main entry point for the HyperTrack SDK
Types
Defines the shape of a geofence destination for order tracking. Two types are supported: circular and polygonal.
The reason for why the SDK doesn't have a fresh location.
The current location of the user and deviation from the expected location for the geotag.
Order assigned to the worker
A collection of orders that are currently assigned to the worker.
Order event
Tracking mode of the order.
Represents an order to be sent for tracking.
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.
Gets the current location once it is available or returns a Set of Errors if it's not possible.
Subscribe to the changes in the errors property (that indicates errors that can prevent the app from successfully tracking)
Subscribe to the changes in the isAvailable property (that indicates availability of the device for the Nearby search)
Subscribe to the changes in the isTracking property (that indicates the tracking intent for the worker)
Subscribe to the changes in the location property (that indicates the current location of the user)'
Subscribe to the changes in the orders property (that indicates 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.