com.github.ignition.location.annotations
Annotation Type IgnitedLocationActivity


@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface IgnitedLocationActivity


Optional Element Summary
 boolean enablePassiveUpdates
          Determines whether passive location updates should be enabled or not.
 int locationUpdatesDistanceDiff
          Determines the minimum difference (in meters) between two location updates.
 long locationUpdatesInterval
          Determines the minimum interval (in milliseconds) between two location updates.
 int minBatteryLevelForGps
          Determines the minimum battery level to enable location updates using GPS.
 int passiveLocationUpdatesDistanceDiff
          Determines the minimum difference (in meters) between two location updates.
 long passiveLocationUpdatesInterval
          Determines the minimum interval (in milliseconds) between two location updates.
 boolean requestLocationUpdates
          Determines whether location updates should be requested or not.
 boolean showWaitForLocationDialog
          Determines whether the activity should display a "wait for location" dialog while the location manager is trying to get a location.
 boolean useGps
          Determines whether to use GPS when requesting location updates or not.
 long waitForGpsFixInterval
          Determines the interval (in milliseconds) to wait for a GPS fix.
 

useGps

public abstract boolean useGps
Determines whether to use GPS when requesting location updates or not. Default value is IgnitedLocationConstants.USE_GPS_DEFAULT).

Returns:
true if GPS is used when requesting location updates, false otherwise.
Default:
true

requestLocationUpdates

public abstract boolean requestLocationUpdates
Determines whether location updates should be requested or not. Default value is IgnitedLocationConstants.REQUEST_LOCATION_UPDATES_DEFAULT).

Returns:
true if location updates should be requested, false otherwise.
Default:
true

locationUpdatesDistanceDiff

public abstract int locationUpdatesDistanceDiff
Determines the minimum difference (in meters) between two location updates. Default value is IgnitedLocationConstants.LOCATION_UPDATES_DISTANCE_DIFF_DEFAULT).

Returns:
the minimum difference (in meters) between two location updates.
Default:
100

locationUpdatesInterval

public abstract long locationUpdatesInterval
Determines the minimum interval (in milliseconds) between two location updates. Default value is IgnitedLocationConstants.LOCATION_UPDATES_INTERVAL_DEFAULT).

Returns:
the minimum interval (in milliseconds) between two location updates.
Default:
300000L

passiveLocationUpdatesDistanceDiff

public abstract int passiveLocationUpdatesDistanceDiff
Determines the minimum difference (in meters) between two location updates. Default value is IgnitedLocationConstants.PASSIVE_LOCATION_UPDATES_DISTANCE_DIFF_DEFAULT).

Returns:
the minimum difference (in meters) between two location updates
Default:
100

passiveLocationUpdatesInterval

public abstract long passiveLocationUpdatesInterval
Determines the minimum interval (in milliseconds) between two location updates. Default value is IgnitedLocationConstants.PASSIVE_LOCATION_UPDATES_INTERVAL_DEFAULT).

Returns:
the minimum interval (in milliseconds) between two location updates.
Default:
900000L

enablePassiveUpdates

public abstract boolean enablePassiveUpdates
Determines whether passive location updates should be enabled or not. Default value is IgnitedLocationConstants.ENABLE_PASSIVE_LOCATION_UPDATES_DEFAULT).

Returns:
true if passive location updates should be enabled, false otherwise.
Default:
true

waitForGpsFixInterval

public abstract long waitForGpsFixInterval
Determines the interval (in milliseconds) to wait for a GPS fix. If a fix is not returned within this interval GPS updates will be disabled and updates from the network will be requested instead. Default value is IgnitedLocationConstants.WAIT_FOR_GPS_FIX_INTERVAL_DEFAULT).

Returns:
the interval (in milliseconds) to wait for a GPS fix.
Default:
30000L

minBatteryLevelForGps

public abstract int minBatteryLevelForGps
Determines the minimum battery level to enable location updates using GPS. Default value is IgnitedLocationConstants.MIN_BATTERY_LEVEL_DEFAULT).

Returns:
the minimum battery level to enable location updates using GPS.
Default:
15

showWaitForLocationDialog

public abstract boolean showWaitForLocationDialog
Determines whether the activity should display a "wait for location" dialog while the location manager is trying to get a location. Default default value is IgnitedLocationConstants.SHOW_WAIT_FOR_LOCATION_DIALOG_DEFAULT). NB: if this is true, the Activity MUST create a dialog in Activity.onCreateDialog(int, android.os.Bundle)

Returns:
true if the activity should display a "wait for location" dialog while the location manager is trying to get a location, false otherwise.
Default:
true


Copyright © 2012. All Rights Reserved.