A B C D E F G H I M N O P R S T U V

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.

addGeotag(Map<String, ?>) - Method in class com.hypertrack.sdk.HyperTrack

Convenience alias to HyperTrack.addGeotag(Map, Location) with null expected location.

addGeotag(Map<String, ?>, Location) - Method in class com.hypertrack.sdk.HyperTrack

Creates geotag with configurable payload.

addTrackingListener(TrackingStateObserver.OnTrackingStateChangeListener) - Method in class com.hypertrack.sdk.HyperTrack

Sets listener, that will be notified when tracking starts/stops or significant error occurred.

allowMockLocations() - Method in class com.hypertrack.sdk.HyperTrack

Allows you to use location mocking software (e.g.

AsyncResultReceiver<V,E> - Interface in com.hypertrack.sdk

Callback for the receiver of an asynchronous result

AUTHORIZATION_ERROR - Static variable in class com.hypertrack.sdk.TrackingError

Your free trial ended or account was not renewed.

B

backgroundTrackingRequirement(boolean) - Method in class com.hypertrack.sdk.HyperTrack

Sets whether to request background location permission on Android 11 and later.

baseApiUrl(String) - Method in class com.hypertrack.sdk.Config.Builder

method to specify domain.

bigIconResId - Variable in class com.hypertrack.sdk.ServiceNotificationConfig

Blocker - Enum in com.hypertrack.sdk

An impediment that should be resolved in order to make the tracking work, or, for some cases, work reliably.

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 enum com.hypertrack.sdk.Blocker

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.

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.

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_DEVICE_ID_ - Static variable in class com.hypertrack.sdk.TrackingStateObserver

Broadcast intent extra data name for tracking event device id.

EXTRA_KEY_MESSAGE_ - Static variable in class com.hypertrack.sdk.TrackingStateObserver

Broadcast intent extra data name for tracking event message.

F

failure(E) - Static method in class com.hypertrack.sdk.Result

G

GeotagResult - Interface in com.hypertrack.sdk

Marker interface for classes that represent HyperTrack.addGeotag(Map, Location) invocation.

GeotagResult.Error - Class in com.hypertrack.sdk

Represents error occurred during geotagging with expected location.

GeotagResult.Error.Reason - Enum in com.hypertrack.sdk

GeotagResult.Success - Class in com.hypertrack.sdk

Result of a successfully created geotag.

GeotagResult.SuccessWithDeviation - Class in com.hypertrack.sdk

Result of a successfully created geotag with expected location.

getBlockers() - Static method in class com.hypertrack.sdk.HyperTrack

getCurrentLocation(AsyncResultReceiver<Location, OutageReason>) - Method in class com.hypertrack.sdk.HyperTrack

Asynchronous access to the current device location.

getDeviationDistance() - Method in class com.hypertrack.sdk.GeotagResult.SuccessWithDeviation

Deviation between expected and actual location in meters.

getDeviceID() - Method in class com.hypertrack.sdk.HyperTrack

getDeviceLocation() - Method in class com.hypertrack.sdk.GeotagResult.Success

getError() - Method in class com.hypertrack.sdk.Result

getInstance(String) - Static method in class com.hypertrack.sdk.HyperTrack

Entry point to SDK usage.

getLatestLocation() - Method in class com.hypertrack.sdk.HyperTrack

Latest device location, that is known to HyperTrack SDK.

getReason() - Method in class com.hypertrack.sdk.GeotagResult.Error

Explanation of why the deviation distance wasn't computed.

getValue() - Method in class com.hypertrack.sdk.Result

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

INVALID_PUBLISHABLE_KEY_ERROR - Static variable in class com.hypertrack.sdk.TrackingError

Publishable key is invalid.

isCritical() - Method in class com.hypertrack.sdk.TrackingError

isFailure() - Method in class com.hypertrack.sdk.Result

Returns true if result has no value and false otherwise

isRunning() - Method in class com.hypertrack.sdk.HyperTrack

isSuccess() - Method in class com.hypertrack.sdk.Result

Returns true if result has the value and false otherwise

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(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.

onResult(Result<V, E>) - Method in interface com.hypertrack.sdk.AsyncResultReceiver

onStart(TrackingStartEvent) - Method in class com.hypertrack.sdk.TrackingStateObserver

onStop(TrackingStopEvent) - Method in class com.hypertrack.sdk.TrackingStateObserver

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.

OutageReason - Enum in com.hypertrack.sdk

P

PERMISSION_DENIED_ERROR - Static variable in class com.hypertrack.sdk.TrackingError

Tracking won't start due to denied (or absent) permission.

R

removeTrackingListener(TrackingStateObserver.OnTrackingStateChangeListener) - Method in class com.hypertrack.sdk.HyperTrack

Removes listener or does nothing, if null was passed in as argument.

requestPermissionsIfNecessary() - Method in class com.hypertrack.sdk.HyperTrack

Convenience method that will issue required permissions request dialog if necessary.

resolve() - Method in enum com.hypertrack.sdk.Blocker

Navigates user to the dedicated settings menu.

Result<V,E> - Class in com.hypertrack.sdk

Abstract operation result

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

setContentIntent(PendingIntent) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder

Deprecated.

This method does nothing. It's kept for backward compatibility only.

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.

setDeviceName(String) - Method in class com.hypertrack.sdk.HyperTrack

Sets current device name, that can be used for easier dashboard navigation.

setLargeIcon(int) - Method in class com.hypertrack.sdk.ServiceNotificationConfig.Builder

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).

stop() - Method in class com.hypertrack.sdk.HyperTrack

Stops current tracking session.

success(V) - Static method in class com.hypertrack.sdk.Result

syncDeviceSettings() - Method in class com.hypertrack.sdk.HyperTrack

This method checks with HyperTrack cloud whether to start or stop tracking.

T

title - Variable in class com.hypertrack.sdk.ServiceNotificationConfig

toString() - Method in enum com.hypertrack.sdk.Blocker

toString() - Method in class com.hypertrack.sdk.ServiceNotificationConfig

toString() - Method in class com.hypertrack.sdk.TrackingError

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

TrackingStateObserver - Class in com.hypertrack.sdk

Main class that reports events when state changed or errors occur in the SDK.

TrackingStateObserver(Context, SdkServiceState, AccountRepository) - Constructor for class com.hypertrack.sdk.TrackingStateObserver

TrackingStateObserver.OnTrackingStateChangeListener - Interface in com.hypertrack.sdk

Used for receiving notifications when tracking state has changed.

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.

userActionCTA - Variable in enum com.hypertrack.sdk.Blocker

userActionExplanation - Variable in enum com.hypertrack.sdk.Blocker

userActionTitle - Variable in enum com.hypertrack.sdk.Blocker

V

valueOf(String) - Static method in enum com.hypertrack.sdk.Blocker

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.hypertrack.sdk.GeotagResult.Error.Reason

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.hypertrack.sdk.OutageReason

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.hypertrack.sdk.Blocker

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.hypertrack.sdk.GeotagResult.Error.Reason

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.hypertrack.sdk.OutageReason

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I M N O P R S T U V