LocationRequest (Meridian API)

java.lang.Object

com.arubanetworks.meridian.location.LocationRequest

public class LocationRequest extends Object

LocationRequest handles getting the current location of the device for a one time use.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

LocationRequest.ErrorType

Error states for a location request.

static interface

LocationRequest.LocationRequestListener

A listener for receiving the results of the request.
Field Summary

Fields

Modifier and Type

Field

Description

static final long

DEFAULT_MAX_AGE

static final long

DEFAULT_TIME_OUT
Method Summary

Modifier and Type

Method

Description

void

cancel()

Cancels this request.

boolean

isRunning()

Returns true if this request is still running.

static LocationRequest

requestCurrentLocation(android.content.Context context, EditorKey appKey, LocationRequest.LocationRequestListener responseListener)

Builds and starts a LocationRequest with the given parameters.

static LocationRequest

requestCurrentLocation(android.content.Context context, EditorKey appKey, LocationRequest.LocationRequestListener responseListener, long timeOutInMilliseconds)

Builds and starts a LocationRequest with the given parameters.

static LocationRequest

requestCurrentLocation(android.content.Context context, EditorKey appKey, LocationRequest.LocationRequestListener responseListener, long timeOutInMilliseconds, long maxAgeInMilliseconds)

Builds and starts a LocationRequest with the given parameters.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- DEFAULT_TIME_OUT
  
  public static final long DEFAULT_TIME_OUT
  See Also:
  
  Constant Field Values
- DEFAULT_MAX_AGE
  
  public static final long DEFAULT_MAX_AGE
  See Also:
  
  Constant Field Values
Method Details
- cancel
  
  public void cancel()
  
  Cancels this request.
- isRunning
  
  public boolean isRunning()
  
  Returns true if this request is still running.
- requestCurrentLocation
  
  public static LocationRequest requestCurrentLocation(android.content.Context context, EditorKey appKey, LocationRequest.LocationRequestListener responseListener)
  
  Builds and starts a LocationRequest with the given parameters.
- requestCurrentLocation
  
  public static LocationRequest requestCurrentLocation(android.content.Context context, EditorKey appKey, LocationRequest.LocationRequestListener responseListener, long timeOutInMilliseconds)
  
  Builds and starts a LocationRequest with the given parameters.
- requestCurrentLocation
  
  public static LocationRequest requestCurrentLocation(@NonNull android.content.Context context, @NonNull EditorKey appKey, @NonNull LocationRequest.LocationRequestListener responseListener, long timeOutInMilliseconds, long maxAgeInMilliseconds)
  
  Builds and starts a LocationRequest with the given parameters.