HyperTrack SDK for Android/com.hypertrack.sdk.android/HyperTrack

HyperTrack

public class HyperTrack
Content copied to clipboard

The main entry point for the HyperTrack SDK

Types

Link copied to clipboard
public final class Cancellable
Content copied to clipboard
Link copied to clipboard
public class Error
Content copied to clipboard
Link copied to clipboard
public final class Location
Content copied to clipboard
Link copied to clipboard
public class LocationError
Content copied to clipboard

The reason for why the SDK doesn't have a fresh location.

Link copied to clipboard
public final class LocationWithDeviation
Content copied to clipboard

Geotag location with deviation from expected location in meters.

Link copied to clipboard
public class OrderStatus
Content copied to clipboard

Order event

Functions

Link copied to clipboard
@Deprecated(message = "Use new addGeotag with orderHandle and orderStatus")
final static Result<HyperTrack.Location, HyperTrack.LocationError> addGeotag(Json.Object data)
Content copied to clipboard

Adds a new geotag.

@Deprecated(message = "Use new addGeotag with orderHandle and orderStatus")
final static Result<HyperTrack.LocationWithDeviation, HyperTrack.LocationError> addGeotag(Json.Object data, HyperTrack.Location expectedLocation)
Content copied to clipboard

Adds a new geotag with expected location.

final static Result<HyperTrack.Location, HyperTrack.LocationError> addGeotag(    String orderHandle,     HyperTrack.OrderStatus orderStatus,     Json.Object metadata)
Content copied to clipboard

Adds a new geotag with order status.

final static Result<HyperTrack.LocationWithDeviation, HyperTrack.LocationError> addGeotag(    String orderHandle,     HyperTrack.OrderStatus orderStatus,     Json.Object metadata,     HyperTrack.Location expectedLocation)
Content copied to clipboard

Adds a new geotag with expected location and order status.

Link copied to clipboard
final static String getDeviceID()
Content copied to clipboard
Link copied to clipboard
final static String getDynamicPublishableKey()
Content copied to clipboard
Link copied to clipboard
final static Set<HyperTrack.Error> getErrors()
Content copied to clipboard
Link copied to clipboard
final static Result<HyperTrack.Location, HyperTrack.LocationError> getLocation()
Content copied to clipboard
Link copied to clipboard
final static Json.Object getMetadata()
Content copied to clipboard
Link copied to clipboard
final static String getName()
Content copied to clipboard
Link copied to clipboard
final static Boolean isAvailable()
Content copied to clipboard
Link copied to clipboard
final static Boolean isTracking()
Content copied to clipboard
Link copied to clipboard
final static HyperTrack.Cancellable locate(Function1<Result<HyperTrack.Location, Set<HyperTrack.Error>>, Unit> callback)
Content copied to clipboard

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

Link copied to clipboard
final Unit registerLocationService(PluginInfo<LocationServices> locationServices)
Content copied to clipboard
Link copied to clipboard
final Unit registerPushService(PluginInfo<PushService> pushService)
Content copied to clipboard
Link copied to clipboard
final static Unit setAvailable(static Boolean isAvailable)
Content copied to clipboard
Link copied to clipboard
final static Unit setDynamicPublishableKey(static String dynamicPublishableKey)
Content copied to clipboard
Link copied to clipboard
final static Unit setMetadata(static Json.Object metadata)
Content copied to clipboard
Link copied to clipboard
final static Unit setName(static String name)
Content copied to clipboard
Link copied to clipboard
final static Unit setTracking(static Boolean isTracking)
Content copied to clipboard
Link copied to clipboard
final static HyperTrack.Cancellable subscribeToErrors(Function1<Set<HyperTrack.Error>, Unit> callback)
Content copied to clipboard

Subscribe to tracking errors

Link copied to clipboard
final static HyperTrack.Cancellable subscribeToIsAvailable(Function1<Boolean, Unit> callback)
Content copied to clipboard

Subscribe to availability changes

Link copied to clipboard
final static HyperTrack.Cancellable subscribeToIsTracking(Function1<Boolean, Unit> callback)
Content copied to clipboard

Subscribe to tracking intent changes

Link copied to clipboard
final static HyperTrack.Cancellable subscribeToLocation(Function1<Result<HyperTrack.Location, HyperTrack.LocationError>, Unit> callback)
Content copied to clipboard

Subscribe to location changes

Properties

Link copied to clipboard
private final static String deviceID
Content copied to clipboard

Returns a string that is used to uniquely identify the device

Link copied to clipboard
private static String dynamicPublishableKey
Content copied to clipboard
Link copied to clipboard
private final static Set<HyperTrack.Error> errors
Content copied to clipboard

Returns any errors that have occurred in the SDK

Link copied to clipboard
public final static HyperTrack INSTANCE
Content copied to clipboard
Link copied to clipboard
private static Boolean isAvailable
Content copied to clipboard

Reflects availability of the device for the Nearby search

Link copied to clipboard
private static Boolean isTracking
Content copied to clipboard

Reflects the tracking intent for the device

Link copied to clipboard
private final static Result<HyperTrack.Location, HyperTrack.LocationError> location
Content copied to clipboard

Reflects the current location of the user or an outage reason

Link copied to clipboard
private static Json.Object metadata
Content copied to clipboard

Gets the metadata that is set for the device

Link copied to clipboard
private static String name
Content copied to clipboard

Gets the name that is set for the device