es.situm.sdk.location

Enum LocationStatus

java.lang.Object

java.lang.Enum<LocationStatus>

es.situm.sdk.location.LocationStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LocationStatus>

public enum LocationStatus
extends java.lang.Enum<LocationStatus>

Location status values used in LocationListener.onStatusChanged(LocationStatus)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLE_NOT_AVAILABLE Bluetooth not available or using Android SDK API < 18.
BLE_SENSOR_DISABLED_BY_USER The BLE sensor has been disabled by the user.
CALCULATING The positioning service is calculating the user location.
COMPASS_CALIBRATION_NEEDED The compass is uncalibrated and need to be calibrated
COMPASS_CALIBRATION_NOT_NEEDED The compass is now calibrated and sending valid data
GLOBAL_LOCATION_NOT_FOUND Used in indoor-outdoor mode during initialization.
NO_CONNECTION Warning received when no internet connection is available
PREPARING_POSITIONING_MODEL The positioning model is been prepared to be used
PROCESSING_POSITIONING_MODEL The positioning model is been processed after download
RETRY_DOWNLOAD_POSITIONING_MODEL The download of the positioning model has failed and the SDK will retry the download
START_DOWNLOADING_POSITIONING_MODEL The download of the positioning model will start
STARTING The positioning system is starting
STARTING_POSITIONING The positioning is starting, it will start to capture and send data
TIME_SETTINGS_MANUAL Time settings configured manually by the user
USER_NOT_IN_BUILDING The user is not in the building calibrated area.

Method Summary

Modifier and Type	Method and Description
static LocationStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LocationStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STARTING

public static final LocationStatus STARTING

The positioning system is starting

PREPARING_POSITIONING_MODEL

public static final LocationStatus PREPARING_POSITIONING_MODEL

The positioning model is been prepared to be used

START_DOWNLOADING_POSITIONING_MODEL

public static final LocationStatus START_DOWNLOADING_POSITIONING_MODEL

The download of the positioning model will start

RETRY_DOWNLOAD_POSITIONING_MODEL

public static final LocationStatus RETRY_DOWNLOAD_POSITIONING_MODEL

The download of the positioning model has failed and the SDK will retry the download

PROCESSING_POSITIONING_MODEL

public static final LocationStatus PROCESSING_POSITIONING_MODEL

The positioning model is been processed after download

STARTING_POSITIONING

public static final LocationStatus STARTING_POSITIONING

The positioning is starting, it will start to capture and send data

USER_NOT_IN_BUILDING

public static final LocationStatus USER_NOT_IN_BUILDING

The user is not in the building calibrated area. Only received in indoor mode

CALCULATING

public static final LocationStatus CALCULATING

The positioning service is calculating the user location. A "keep walking" or loading message can be shown to the user

NO_CONNECTION

public static final LocationStatus NO_CONNECTION

Warning received when no internet connection is available

COMPASS_CALIBRATION_NEEDED

public static final LocationStatus COMPASS_CALIBRATION_NEEDED

The compass is uncalibrated and need to be calibrated

COMPASS_CALIBRATION_NOT_NEEDED

public static final LocationStatus COMPASS_CALIBRATION_NOT_NEEDED

The compass is now calibrated and sending valid data

BLE_NOT_AVAILABLE

public static final LocationStatus BLE_NOT_AVAILABLE

Bluetooth not available or using Android SDK API < 18. BLE scanning is not supported before API 18

TIME_SETTINGS_MANUAL

public static final LocationStatus TIME_SETTINGS_MANUAL

Time settings configured manually by the user

GLOBAL_LOCATION_NOT_FOUND

public static final LocationStatus GLOBAL_LOCATION_NOT_FOUND

Used in indoor-outdoor mode during initialization. This is returned when Google Location provider doesn't return locations in the first 30s. The location system will keep trying to receive a location.

BLE_SENSOR_DISABLED_BY_USER

public static final LocationStatus BLE_SENSOR_DISABLED_BY_USER

The BLE sensor has been disabled by the user. BLE scanning will be disabled if LocationRequest.useBle is true and LocationRequest.autoEnableBleDuringPositioning() is false.

Method Detail

values

public static LocationStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LocationStatus c : LocationStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static LocationStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null