public interface

GuideOptions

com.steerpath.sdk.location.GuideOptions

Class Overview

Runtime configuration options for indoor positioning engine.

Summary

Public Methods
abstract GuideOptions accelerometer(boolean isEnabled)
Call apply() to make configuration effective.
abstract void apply()
Applies previously defined configuration.
abstract GuideOptions compass(boolean isEnabled)
Call apply() to make configuration effective.
abstract GuideOptions configuration(String key, Object value)
Debugging use only.
abstract GuideOptions eddystoneNamespace(String hexString)
Set Eddystone namespace which will be monitored.
abstract String getEddystoneNamespace()
abstract UUID getIBeaconUUID()
abstract int getRssi()
abstract GuideOptions gyroscope(boolean isEnabled)
Call apply() to make configuration effective.
abstract GuideOptions iBeaconUUID(UUID proximityUUID128)
Set the iBeacon proximity UUID which will monitored.
abstract boolean isAccelerometerEnabled()
abstract boolean isCompassEnabled()
abstract boolean isGyroscopeEnabled()
abstract GuideOptions rssi(int rssi)
Call apply() to make configuration effective.

Public Methods

public abstract GuideOptions accelerometer (boolean isEnabled)

Call apply() to make configuration effective.

public abstract void apply ()

Applies previously defined configuration.

public abstract GuideOptions compass (boolean isEnabled)

Call apply() to make configuration effective.

public abstract GuideOptions configuration (String key, Object value)

Debugging use only. Allows modification of some internal setting.
Call apply() to make configuration effective.

Parameters
key key the name of the configuration parameter to set.
value value the new value for the configuration parameter.

public abstract GuideOptions eddystoneNamespace (String hexString)

Set Eddystone namespace which will be monitored.

public abstract String getEddystoneNamespace ()

public abstract UUID getIBeaconUUID ()

public abstract int getRssi ()

public abstract GuideOptions gyroscope (boolean isEnabled)

Call apply() to make configuration effective.

public abstract GuideOptions iBeaconUUID (UUID proximityUUID128)

Set the iBeacon proximity UUID which will monitored.

Be sure to set the iBeacon UUID only after the NDD has loaded, or it will get over- written by the value from the NDD.

Parameters
proximityUUID128 the 128-bit UUID to monitor for

public abstract boolean isAccelerometerEnabled ()

public abstract boolean isCompassEnabled ()

public abstract boolean isGyroscopeEnabled ()

public abstract GuideOptions rssi (int rssi)

Call apply() to make configuration effective.

Parameters
rssi range: -16 - 16