Package com.geouniq.android

Enum Class GeoUniq.TrackingProfile.GpsUsage

java.lang.Object
java.lang.Enum<GeoUniq.TrackingProfile.GpsUsage>
com.geouniq.android.GeoUniq.TrackingProfile.GpsUsage
All Implemented Interfaces:
Serializable, Comparable<GeoUniq.TrackingProfile.GpsUsage>, Constable
Enclosing class:
GeoUniq.TrackingProfile
public static enum GeoUniq.TrackingProfile.GpsUsage extends Enum<GeoUniq.TrackingProfile.GpsUsage>
Enumeration that defines the GPS-usage attribute for GeoUniq.TrackingProfile.

Values of this enumeration indicate how much the GPS can be used when detecting the location of the device for the background tracking.

Note that, regardless of the specific value for this attribute, GeoUniq SDK will always avoid using GPS unnecessary. Instead, when needed to detect the location of the device, the GPS will be used according to the value of this attribute.

Note also that this attribute does not impact the behavior of GeoUniq SDK when the location is detected after calling GeoUniq.getLocation(float, ILocationListener, IErrorListener).

Used with GeoUniq.setTrackingProfile(TrackingProfile) and GeoUniq.getTrackingProfile().

  • Enum Constant Details

    • NEVER_ALLOWED

      public static final GeoUniq.TrackingProfile.GpsUsage NEVER_ALLOWED
      GPS usage is never allowed.

      Setting thus value does not guarantee the minimum battery drain if the location of the device cannot be detected from the other geolocation systems.

    • HARDLY_EVER_ALLOWED

      public static final GeoUniq.TrackingProfile.GpsUsage HARDLY_EVER_ALLOWED
      GPS usage is highly restricted.

      This value allows to still detect the location of the device in those cases when the other geolocation systems fail, and might even lead to a lower battery drain than NEVER_ALLOWED by avoiding using the other geolocation systems too often without succeeding.

      This is the default value used by GeoUniq SDK and the most recommended one.

    • SUFFICIENTLY_ALLOWED

      public static final GeoUniq.TrackingProfile.GpsUsage SUFFICIENTLY_ALLOWED
      GPS usage is sufficiently allowed.

      This value gives several chances to use GPS when the other geolocation systems fail, thus allowing a better tracking but could lead to a little increase in battery drain.

    • ALMOST_ALWAYS_ALLOWED

      public static final GeoUniq.TrackingProfile.GpsUsage ALMOST_ALWAYS_ALLOWED
      GPS usage is almost always allowed.

      This value guarantees very good tracking but could lead to a significant increase in battery drain in those cases when detecting the location of the device through the other geolocation systems fails systematically.

      Using this value as typical behavior is highly discouraged.

    • ALWAYS_ALLOWED

      public static final GeoUniq.TrackingProfile.GpsUsage ALWAYS_ALLOWED
      GPS usage is always allowed.

      This value guarantees the best tracking but could lead to a dramatic increase in battery drain in those cases when detecting the location of the device through the other geolocation systems fails systematically.

      Using this value as typical behavior is highly discouraged, especially if

  • Method Details

    • values

      public static GeoUniq.TrackingProfile.GpsUsage[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static GeoUniq.TrackingProfile.GpsUsage valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null