public final class

DeveloperOptions

extends Object
java.lang.Object
   ↳ com.steerpath.sdk.common.DeveloperOptions

Class Overview

Developer mode for making developer's daily life slightly easier. Some of the features requires special build configuration in order to work and are not available in standard SDK.

Summary

Constants
int DISABLED Master switch: OFF

Removes "Monitor"-button from SteerpathMapView.
int ENABLED Master switch: ON

Adds "Monitor"-button to SteerpathMapView.
int WITH_ACCELERATED_CACHE_AGEING Normally cache age is 24h.
int WITH_BEACON_INFO Prints nearby beacon namespace and instance ID in the logcat.
int WITH_BLUETOOTH_SCANNER_FAILURE_TEST Instead of using real BluetoothScanner, uses mockup instead.
int WITH_EID_MONITOR Periodically checks if valid EID is available for each building and for current date.
int WITH_FLOATING_SDK_INFO Adds floating TextView in top | left corner of SteerpathMapView.
int WITH_HEALTH_MONITOR Periodic (1min interval) system checks.
int WITH_LOCATION_MONITOR Collects periodically Location data and adds it to the SDK logs.
int WITH_MONITOR "Monitor" is simple logging tool that just pretty prints things to logcat.
int WITH_NATIVE_LOGGING Includes C-level SDK logging.
int WITH_PERSISTENT_OFFLINE_BUNDLE When this is set, SDK does not uninstall OfflineBundle when app is launched from the Android Studio.
int WITH_STACK_TRACES Appends stack traces to Monitor if crash occurs.
Public Methods
static int getAdvancedFieldTestOptions()
Options for field testing when something seems to be terribly wrong.
static int getAllOptions()
Options that enables everything.
static int getBasicFieldTestOptions()
Options for common field testing.
static int getDefaultOptions()
Default simple configuration for development.
static int getLimitedFieldTestOptions()
Options for limited field testing.
static int getNetworkTestOptions()
Options for network stats.
static boolean isBeaconInfoEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR and WITH_BEACON_INFO are defined.
static boolean isCacheAgeAccelerationEnabled(int bitmask)
Checks if ENABLED and WITH_ACCELERATED_CACHE_AGEING are defined.
static boolean isEidMonitorEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR, WITH_HEALTH_MONITOR and WITH_EID_MONITOR are defined.
static boolean isEnabled(int bitmask)
Checks if ENABLED is defined.
static boolean isFloatingSdkInfoEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR and WITH_FLOATING_SDK_INFO are defined.
static boolean isHealthMonitorEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR and WITH_HEALTH_MONITOR are defined.
static boolean isLocationMonitorEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR, WITH_HEALTH_MONITOR and WITH_LOCATION_MONITOR are defined.
static boolean isMonitorEnabled(int bitmask)
Checks if ENABLED and WITH_MONITOR are defined.
static boolean isNativeLoggingEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR and WITH_NATIVE_LOGGING are defined.
static boolean isPersistentOfflineBundleEnabled(int bitmask)
Checks if ENABLED and WITH_PERSISTENT_OFFLINE_BUNDLE are defined.
static boolean isStackTracingEnabled(int bitmask)
Checks if ENABLED, WITH_MONITOR and WITH_STACK_TRACES are defined.
static boolean isTestBluetoothScannerEnabled(int bitmask)
Checks if WITH_BLUETOOTH_SCANNER_FAILURE_TEST is defined.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int DISABLED

Master switch: OFF

Removes "Monitor"-button from SteerpathMapView.

Constant Value: 0 (0x00000000)

public static final int ENABLED

Master switch: ON

Adds "Monitor"-button to SteerpathMapView.

Constant Value: 1 (0x00000001)

public static final int WITH_ACCELERATED_CACHE_AGEING

Normally cache age is 24h. As a fast paced developer, we don't have that much time to wait. With this enabled, files expire in 5 mins instead and map tile max-age is 1min. Normally these values are 24h and 12h.

Requires special compilation flag to work.

Constant Value: 16 (0x00000010)

public static final int WITH_BEACON_INFO

Prints nearby beacon namespace and instance ID in the logcat. Requires WITH_MONITOR.

Constant Value: 32 (0x00000020)

public static final int WITH_BLUETOOTH_SCANNER_FAILURE_TEST

Instead of using real BluetoothScanner, uses mockup instead. It simulates BluetoothScanner failures. When this is in use, Bluetooth Scan events are passed normally but every 30 seconds, SCAN_FAILED_APPLICATION_REGISTRATION_FAILED will be thrown. When this happens, some "Bogus Location" warnings should appear on SDK logs. Bluetooth stack is not corrupted in reality, it is just a faked error.

Constant Value: 512 (0x00000200)

public static final int WITH_EID_MONITOR

Periodically checks if valid EID is available for each building and for current date. Requires WITH_MONITOR and WITH_HEALTH_MONITOR.
WARNING: This is heavy operation and currently not done in background thread! Probably your ANRWatchDog starts complaining and BlueDot animations freezes for a second!

Constant Value: 1024 (0x00000400)

public static final int WITH_FLOATING_SDK_INFO

Adds floating TextView in top | left corner of SteerpathMapView. It contains name of the SDK log file and current timestamp. Useful when trying to connect SDK logs with screen recordings. Requires WITH_MONITOR.

Constant Value: 64 (0x00000040)

public static final int WITH_HEALTH_MONITOR

Periodic (1min interval) system checks. Requires WITH_MONITOR.

Constant Value: 4 (0x00000004)

public static final int WITH_LOCATION_MONITOR

Collects periodically Location data and adds it to the SDK logs. Extends WITH_HEALTH_MONITOR. Requires special compilation flag to work.

Constant Value: 256 (0x00000100)

public static final int WITH_MONITOR

"Monitor" is simple logging tool that just pretty prints things to logcat.
Steerpath developer may ask you to capture this:
adb logcat *:S Monitor:V

Constant Value: 2 (0x00000002)

public static final int WITH_NATIVE_LOGGING

Includes C-level SDK logging. Requires WITH_MONITOR.

Constant Value: 2048 (0x00000800)

public static final int WITH_PERSISTENT_OFFLINE_BUNDLE

When this is set, SDK does not uninstall OfflineBundle when app is launched from the Android Studio. Waiting for large OfflineBundle to be uninstalled and then re-installed each time debugger is launched is really infuriating >:|

Constant Value: 8 (0x00000008)

public static final int WITH_STACK_TRACES

Appends stack traces to Monitor if crash occurs.

Constant Value: 128 (0x00000080)

Public Methods

public static int getAdvancedFieldTestOptions ()

Options for field testing when something seems to be terribly wrong.

public static int getAllOptions ()

Options that enables everything.

public static int getBasicFieldTestOptions ()

Options for common field testing.

public static int getDefaultOptions ()

Default simple configuration for development.

public static int getLimitedFieldTestOptions ()

Options for limited field testing.

public static int getNetworkTestOptions ()

Options for network stats.

public static boolean isBeaconInfoEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR and WITH_BEACON_INFO are defined.

Requires special compilation flag to work.

public static boolean isCacheAgeAccelerationEnabled (int bitmask)

Checks if ENABLED and WITH_ACCELERATED_CACHE_AGEING are defined.

Requires special compilation flag to work.

public static boolean isEidMonitorEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR, WITH_HEALTH_MONITOR and WITH_EID_MONITOR are defined.

public static boolean isEnabled (int bitmask)

Checks if ENABLED is defined.

public static boolean isFloatingSdkInfoEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR and WITH_FLOATING_SDK_INFO are defined.

public static boolean isHealthMonitorEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR and WITH_HEALTH_MONITOR are defined.

public static boolean isLocationMonitorEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR, WITH_HEALTH_MONITOR and WITH_LOCATION_MONITOR are defined.

public static boolean isMonitorEnabled (int bitmask)

Checks if ENABLED and WITH_MONITOR are defined.

public static boolean isNativeLoggingEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR and WITH_NATIVE_LOGGING are defined.

public static boolean isPersistentOfflineBundleEnabled (int bitmask)

Checks if ENABLED and WITH_PERSISTENT_OFFLINE_BUNDLE are defined.

public static boolean isStackTracingEnabled (int bitmask)

Checks if ENABLED, WITH_MONITOR and WITH_STACK_TRACES are defined.

public static boolean isTestBluetoothScannerEnabled (int bitmask)

Checks if WITH_BLUETOOTH_SCANNER_FAILURE_TEST is defined.