Package es.situm.sdk.location

Enum LocationRequest.RealtimeUpdateInterval

java.lang.Object

java.lang.Enum<LocationRequest.RealtimeUpdateInterval>

es.situm.sdk.location.LocationRequest.RealtimeUpdateInterval

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LocationRequest.RealtimeUpdateInterval>

Enclosing class:

LocationRequest

public static enum LocationRequest.RealtimeUpdateInterval
extends java.lang.Enum<LocationRequest.RealtimeUpdateInterval>

Enum that allows to specify whether the geolocations computed should be sent to Situm Platform, and if so with which periodicity (time interval). Situm computes one geolocation per second, so several geolocations may be computed within each time interval: in this case, they will be accumulated and sent in bulk. If for whatever reason geolocations can not be uploaded (e.g. network failure, app crash, etc.), Situm SDK will retry in the future.

These geolocations will be visualized in the Dashboard's Realtime Panel, hence the name of the Enum.

Short time intervals are only recommended if you need to know the geolocation of the user at all times without much delay (e.g. tracking applications with realtime response requirements). Otherwise, you may want to increase the time interval: this will result in significant battery savings.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BATTERY_SAVER	Computed geolocations will be sent to Situm Platform every 30 minutes.
FAST	Computed geolocations will be accumulated and sent to Situm Platform every 5 seconds.
NEVER	Computed geolocations won't be uploaded to Situm Platform.
NORMAL	Computed geolocations will be accumulated and sent to Situm Platform every 15 seconds.
REALTIME	Computed geolocations will be sent to Situm Platform every second.
SLOW	Computed geolocations will be sent to Situm Platform every 25 seconds.

Method Summary

Modifier and Type	Method	Description
int	getInterval()	Gets the time interval (in milliseconds) between consecutive indoor geolocations communicated via LocationListener.onLocationChanged(Location) callback.
static LocationRequest.RealtimeUpdateInterval	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static LocationRequest.RealtimeUpdateInterval[]	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

REALTIME

public static final LocationRequest.RealtimeUpdateInterval REALTIME

Computed geolocations will be sent to Situm Platform every second. Battery typically lasts 9-12 hours.

FAST

public static final LocationRequest.RealtimeUpdateInterval FAST

Computed geolocations will be accumulated and sent to Situm Platform every 5 seconds. Battery typically lasts 10-13 hours.

NORMAL

public static final LocationRequest.RealtimeUpdateInterval NORMAL

Computed geolocations will be accumulated and sent to Situm Platform every 15 seconds. Battery typically lasts 12-15 hours.

SLOW

public static final LocationRequest.RealtimeUpdateInterval SLOW

Computed geolocations will be sent to Situm Platform every 25 seconds. Battery typically lasts 14-16 hours.

BATTERY_SAVER

public static final LocationRequest.RealtimeUpdateInterval BATTERY_SAVER

Computed geolocations will be sent to Situm Platform every 30 minutes. Battery typically lasts up to 24 hours (Situm SDK battery consumption is negligible).

This option only works on SDK 2.25.1 and above.

NEVER

public static final LocationRequest.RealtimeUpdateInterval NEVER

Computed geolocations won't be uploaded to Situm Platform. Battery typically lasts up to 24 hours (Situm SDK battery consumption is negligible).

You will not be able to see the users' geolocations in the Dashboard's Realtime Panel dashboard, nor to generate location based analytics.

Please take into account that activating this option might also reduce our ability to provide remote support, although we will still store some debugging information to be able to assist you.

This option only works on SDK 2.47.0 and above.

Method Detail

values

public static LocationRequest.RealtimeUpdateInterval[] 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 (LocationRequest.RealtimeUpdateInterval c : LocationRequest.RealtimeUpdateInterval.values())
    System.out.println(c);

Returns:

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

valueOf

public static LocationRequest.RealtimeUpdateInterval 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

getInterval

public int getInterval()

Gets the time interval (in milliseconds) between consecutive indoor geolocations communicated via LocationListener.onLocationChanged(Location) callback.

To set this value, use LocationRequest.Builder.interval(int). Default value is 1000 milliseconds.

Returns:

value in milliseconds