Skip navigation links
A B C D E G H I M N O P R S T U 

A

ACTION_TRACKING_ERROR - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Deprecated.
ACTION_TRACKING_STATE - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Broadcast intent action when state changed or errors occur in the SDK.
addNotificationIconsAndTitle(int, int, String, String) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.setTrackingNotificationConfig(ServiceNotificationConfig) Updates notification, that SDK will show once tracking is active.
addNotificationIconsAndTitle(int, int, String, String, PendingIntent) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.setTrackingNotificationConfig(ServiceNotificationConfig) Updates notification, that SDK will show once tracking is active.
addTrackingListener(TrackingStateObserver.OnTrackingStateChangeListener) - Method in class com.hypertrack.sdk.HyperTrack
Sets listener, that will be notified when tracking starts/stops or significant error occurred.
addTrackingStateListener(TrackingStateObserver.OnTrackingStateChangeListener) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
use HyperTrack.addTrackingListener(TrackingStateObserver.OnTrackingStateChangeListener) instead. Registers a tracking state callback. SDK reinitialization removes all listeners.
addTripMarker(Map<String, Object>) - Method in class com.hypertrack.sdk.HyperTrack
Creates marker in trip with configurable payload.
addTripMarker(String) - Method in class com.hypertrack.sdk.HyperTrack
Creates marker in trip with configurable payload.
allowMockLocations() - Method in class com.hypertrack.sdk.HyperTrack
Allows you to use location mocking software (e.g.
AsyncResultHandler<T> - Interface in com.hypertrack.sdk
 
AUTHORIZATION_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Your free trial ended or account was not renewed.
AuthorizationError() - Constructor for exception com.hypertrack.sdk.TrackingInitError.AuthorizationError
Deprecated.
 

B

baseApiUrl(String) - Method in class com.hypertrack.sdk.Config.Builder
method to specify domain.
bigIconResId - Variable in class com.hypertrack.sdk.ServiceNotificationConfig
 
body - Variable in class com.hypertrack.sdk.ServiceNotificationConfig
 
build() - Method in class com.hypertrack.sdk.Config.Builder
Create final instance of config Config
build() - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
Builder() - Constructor for class com.hypertrack.sdk.Config.Builder
 
Builder() - Constructor for class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 

C

clickActionPendingIntent - Variable in class com.hypertrack.sdk.ServiceNotificationConfig
 
code - Variable in class com.hypertrack.sdk.TrackingError
Code of tracking error from TrackingError.
com.hypertrack.sdk - package com.hypertrack.sdk
 
Config - Class in com.hypertrack.sdk
Configuration class Config to setup Sdk initialization.
Config.Builder - Class in com.hypertrack.sdk
Builder to setup Config.
CoreSDKState - Class in com.hypertrack.sdk
Created by ravi on 6/28/18.
customEvent(Map<String, Object>) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Since 3.3.0 Use HyperTrack.addTripMarker(Map) instead.

D

DATA_STORE_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Database error while data saving.

E

enableAutoStartTracking(boolean) - Method in class com.hypertrack.sdk.Config.Builder
method to specify tracking behavior.
enableDebugLogging() - Static method in class com.hypertrack.sdk.HyperTrack
Enables debug log output.
enableMockLocation() - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.allowMockLocations() instead. Allows you to use mock provider to generate location data for tests etc.
EXTRA_EVENT_CODE_START - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Broadcast intent code when tracking has started.
EXTRA_EVENT_CODE_STOP - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Broadcast intent code when tracking has stopped.
EXTRA_KEY_CODE_ - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Broadcast intent extra data name for tracking event code.
EXTRA_KEY_MESSAGE_ - Static variable in class com.hypertrack.sdk.TrackingStateObserver
Broadcast intent extra data name for tracking event message.

G

getActivity() - Method in class com.hypertrack.sdk.CoreSDKState
 
getAuthToken() - Method in class com.hypertrack.sdk.CoreSDKState
 
getDeviceId() - Method in class com.hypertrack.sdk.CoreSDKState
 
getDeviceID() - Method in class com.hypertrack.sdk.HyperTrack
 
getDeviceId() - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
getInstance(DataStore, Context) - Static method in class com.hypertrack.sdk.CoreSDKState
 
getInstance(Context, String) - Static method in class com.hypertrack.sdk.HyperTrack
Entry point to SDK usage.
getLastEventSentTimestamp() - Method in class com.hypertrack.sdk.CoreSDKState
 
getLastSyncTime() - Method in class com.hypertrack.sdk.CoreSDKState
 
getOfflineStarted() - Method in class com.hypertrack.sdk.CoreSDKState
 
getPublishableKey() - Method in class com.hypertrack.sdk.CoreSDKState
 
GPS_PROVIDER_DISABLED_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Tracking won't start due to disabled gps.

H

HyperTrack - Class in com.hypertrack.sdk
Main interface to use HyperTrack Android SDK in your app.

I

initialize(Context, String) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.getInstance(Context, String) instead. Convenience method that calls HyperTrack.initialize(Context, String, Config) with default config and auto start tracking. See aforementioned method description for details.
initialize(Context, String, boolean) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.getInstance(Context, String) and HyperTrack.start() instead. E.g.:
 
     HyperTrack sdk = HyperTrack.getInstance(context, myPublishableKey)
                         .start();
     // retain sdk reference to get device id or stop tracking.

 
Convenience method that calls HyperTrack.initialize(Context, String, Config) with default config and selected shouldStartTracking. See aforementioned method description for details.
initialize(Context, String, Config) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.getInstance(Context, String) and HyperTrack.start() E.g.
     
         HyperTrack sdk = HyperTrack.getInstance(context, myPublishableKey)
                             .start();
         // retain sdk reference to get device id or stop tracking.
     

 
Most custom way to initialize HyperTrack SDK with configConfig.
initialize(Activity, String, TrackingInitDelegate) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
initialize(Activity, String, boolean, boolean, TrackingInitDelegate) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
INVALID_PUBLISHABLE_KEY_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Publishable key is invalid.
InvalidPublishableKeyError() - Constructor for exception com.hypertrack.sdk.TrackingInitError.InvalidPublishableKeyError
Deprecated.
 
isActivityEnabled() - Method in class com.hypertrack.sdk.CoreSDKState
 
isCharging() - Method in class com.hypertrack.sdk.CoreSDKState
 
isCritical() - Method in class com.hypertrack.sdk.TrackingError
 
isFakeLocationProhibited() - Method in class com.hypertrack.sdk.CoreSDKState
 
isInitialized() - Method in class com.hypertrack.sdk.CoreSDKState
 
isLocationPermissionsGranted() - Method in class com.hypertrack.sdk.CoreSDKState
 
isLocationProviderEnabled() - Method in class com.hypertrack.sdk.CoreSDKState
 
isLowBattery() - Method in class com.hypertrack.sdk.CoreSDKState
 
isOffline() - Method in class com.hypertrack.sdk.CoreSDKState
 
isRunning() - Method in class com.hypertrack.sdk.HyperTrack
 
isTracking() - Method in class com.hypertrack.sdk.CoreSDKState
 
isTracking() - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
use HyperTrack.isRunning() instead Check tracking status.

M

message - Variable in class com.hypertrack.sdk.TrackingError
Message of tracking error from.
mSdkProvider - Variable in class com.hypertrack.sdk.HyperTrack
 

N

NOTIFICATION_ICON_NO_VALUE - Static variable in class com.hypertrack.sdk.ServiceNotificationConfig
 

O

onError(TrackingInitError) - Method in interface com.hypertrack.sdk.TrackingInitDelegate
Deprecated.
Will be invoked only in case of failure.
onError(TrackingErrorEvent) - Method in class com.hypertrack.sdk.TrackingStateObserver
 
onError(TrackingError) - Method in interface com.hypertrack.sdk.TrackingStateObserver.OnTrackingStateChangeListener
Called to report errors in the SDK.
onFailure(Error) - Method in interface com.hypertrack.sdk.AsyncResultHandler
 
onResultReceived(T) - Method in interface com.hypertrack.sdk.AsyncResultHandler
 
onStart(TrackingStartEvent) - Method in class com.hypertrack.sdk.TrackingStateObserver
 
onStop(TrackingStopEvent) - Method in class com.hypertrack.sdk.TrackingStateObserver
 
onSuccess() - Method in interface com.hypertrack.sdk.TrackingInitDelegate
Deprecated.
Will be invoked on successful result.
onTrackingStart() - Method in interface com.hypertrack.sdk.TrackingStateObserver.OnTrackingStateChangeListener
Called to report tracking started.
onTrackingStop() - Method in interface com.hypertrack.sdk.TrackingStateObserver.OnTrackingStateChangeListener
Called to report tracking stopped.

P

PERMISSION_DENIED_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Tracking won't start due to denied (or absent) permission.
PermissionDeniedError() - Constructor for exception com.hypertrack.sdk.TrackingInitError.PermissionDeniedError
Deprecated.
 

R

removeTrackingListener(TrackingStateObserver.OnTrackingStateChangeListener) - Method in class com.hypertrack.sdk.HyperTrack
Removes listener or does nothing, if null was passed in as argument.
removeTrackingStateListener(TrackingStateObserver.OnTrackingStateChangeListener) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
requestPermissionsIfNecessary() - Method in class com.hypertrack.sdk.HyperTrack
Convenience method that will issue required permissions request dialog if necessary.

S

ServiceNotificationConfig - Class in com.hypertrack.sdk
Allows you to configure HyperTrack service notification properties.
ServiceNotificationConfig(String, String, int, int, PendingIntent) - Constructor for class com.hypertrack.sdk.ServiceNotificationConfig
 
ServiceNotificationConfig.Builder - Class in com.hypertrack.sdk
 
setAuthToken(String) - Method in class com.hypertrack.sdk.CoreSDKState
 
setContentIntent(PendingIntent) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
setContentText(String) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
setContentTitle(String) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
setDeviceMetadata(Map<String, Object>) - Method in class com.hypertrack.sdk.HyperTrack
Sets current device data, that can be used for easier dashboard navigation or grouping of location data in tag groups style.
setDeviceMetadata(String) - Method in class com.hypertrack.sdk.HyperTrack
Sets current device data, that can be used for easier dashboard navigation or grouping of location data in tag groups style.
setDeviceName(String) - Method in class com.hypertrack.sdk.HyperTrack
Sets current device name, that can be used for easier dashboard navigation.
setIsActivityEnabled(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setIsCharging(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setIsInitialized(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setIsLocationPermissionGiven(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setIsLowBattery(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setLargeIcon(int) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
setLastCheck(long) - Method in class com.hypertrack.sdk.CoreSDKState
 
setNameAndMetadataForDevice(String, Map<String, Object>) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.setDeviceName(String) and HyperTrack.setDeviceMetadata(Map) instead. Sets current device data, that can be used for easier dashboard navigation. Use only after you've initialized the SDK. This setter is intended to be used for static data, that doesn't change during tracking sessions, as no SLA regarding this data propagation provided. In case of frequent changes, it is possible, that intermediate states could be lost, so if more real-time responsiveness is required it is recommended to use HyperTrack.addTripMarker(Map) for passing that data.
setOffline(boolean) - Method in class com.hypertrack.sdk.CoreSDKState
 
setPublishableKey(String) - Method in class com.hypertrack.sdk.CoreSDKState
 
setSmallIcon(int) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder
 
setTrackingNotificationConfig(ServiceNotificationConfig) - Method in class com.hypertrack.sdk.HyperTrack
Allows to to customize persistent notification elements.
smallIconResId - Variable in class com.hypertrack.sdk.ServiceNotificationConfig
 
start() - Method in class com.hypertrack.sdk.HyperTrack
Starts tracking, if all requirements are met (permissions are granted and publisahble Key is validated).
startTracking(boolean, TrackingInitDelegate) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
startTracking() - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.start() instead. Resumes tracking, that was previously paused by HyperTrack.stopTracking() invocation. This should not be called, if you haven't paused tracking previously, since it default state is enabled. Please note, that if user hasn't granted location data access permission tracking service won't actually run. Use HyperTrack.isTracking() to determine current tracking state.
stop() - Method in class com.hypertrack.sdk.HyperTrack
Stops current tracking session.
stopTracking() - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.stop() instead. Pauses tracking. Use HyperTrack.startTracking(boolean, TrackingInitDelegate) to start tracking service again.
syncDeviceSettings() - Method in class com.hypertrack.sdk.HyperTrack
Sync device state with backend model.

T

title - Variable in class com.hypertrack.sdk.ServiceNotificationConfig
 
toString() - Method in class com.hypertrack.sdk.ServiceNotificationConfig
 
TrackingError - Class in com.hypertrack.sdk
Various kind of errors, notifying about initialization failure reason.
TrackingError() - Constructor for class com.hypertrack.sdk.TrackingError
 
TrackingError(int) - Constructor for class com.hypertrack.sdk.TrackingError
 
TrackingError(int, String) - Constructor for class com.hypertrack.sdk.TrackingError
 
TrackingInitDelegate - Interface in com.hypertrack.sdk
Deprecated.
TrackingInitError - Exception in com.hypertrack.sdk
Deprecated.
Use TrackingError instead
TrackingInitError() - Constructor for exception com.hypertrack.sdk.TrackingInitError
Deprecated.
 
TrackingInitError.AuthorizationError - Exception in com.hypertrack.sdk
Deprecated.
This one is returned if key is recognized by system, but service will not be provided
TrackingInitError.InvalidPublishableKeyError - Exception in com.hypertrack.sdk
Deprecated.
This will be returned in case of publishable key not been recognized by system
TrackingInitError.PermissionDeniedError - Exception in com.hypertrack.sdk
Deprecated.
Returned if tracking won't start due to denied (or absent) permission
TrackingStateObserver - Class in com.hypertrack.sdk
Main class that reports events when state changed or errors occur in the SDK.
TrackingStateObserver.OnTrackingStateChangeListener - Interface in com.hypertrack.sdk
Used for receiving notifications when tracking state has changed.
tripMarker(Map<String, Object>) - Static method in class com.hypertrack.sdk.HyperTrack
Deprecated.
Use HyperTrack.addTripMarker(Map) instead. Creates marker in trip with configurable payload. Please, bear in mind that this will be serialized as json so passing in recursive datastructure could lead to unpredictable results.

U

UNKNOWN_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
An error that we couldn't recognize.
UNKNOWN_NETWORK_ERROR - Static variable in class com.hypertrack.sdk.TrackingError
Request error that we couldn't recognize.
updateLastEventSentTimestamp() - Method in class com.hypertrack.sdk.CoreSDKState
 
updateLastSyncTime(long) - Method in class com.hypertrack.sdk.CoreSDKState
 
A B C D E G H I M N O P R S T U 
Skip navigation links