Added in API level 3
Deprecated in API level 24

Summary: Nested Classes | Constants | Methods | Inherited Methods

GpsStatus

Kotlin |Java

public final class GpsStatus
extends Object

java.lang.Object
↳	android.location.GpsStatus

This class was deprecated in API level 24.
Use GnssStatus instead.

This class represents the current state of the GPS engine and is used in conjunction with GpsStatus.Listener.

Summary

Nested classes
`interface`	`GpsStatus.Listener` This interface was deprecated in API level 24. Use `GnssStatus.Callback` instead.
`interface`	`GpsStatus.NmeaListener` This interface was deprecated in API level 24. use `OnNmeaMessageListener` instead.

Constants
`int`	`GPS_EVENT_FIRST_FIX` Event sent when the GPS system has received its first fix since starting.
`int`	`GPS_EVENT_SATELLITE_STATUS` Event sent periodically to report GPS satellite status.
`int`	`GPS_EVENT_STARTED` Event sent when the GPS system has started.
`int`	`GPS_EVENT_STOPPED` Event sent when the GPS system has stopped.

Public methods
`static GpsStatus`	`create(GnssStatus gnssStatus, int timeToFirstFix)` Builds a GpsStatus from the given GnssStatus.
`int`	`getMaxSatellites()` Returns the maximum number of satellites that can be in the satellite list that can be returned by `getSatellites()`.
`Iterable<GpsSatellite>`	`getSatellites()` Returns an array of `GpsSatellite` objects, which represent the current state of the GPS engine.
`int`	`getTimeToFirstFix()` Returns the time required to receive the first fix since the most recent restart of the GPS engine.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

GPS_EVENT_FIRST_FIX

Added in API level 3

public static final int GPS_EVENT_FIRST_FIX

Event sent when the GPS system has received its first fix since starting. Call getTimeToFirstFix() to find the time from start to first fix.

Constant Value: 3 (0x00000003)

GPS_EVENT_SATELLITE_STATUS

Added in API level 3

public static final int GPS_EVENT_SATELLITE_STATUS

Event sent periodically to report GPS satellite status. Call getSatellites() to retrieve the status for each satellite.

Constant Value: 4 (0x00000004)

GPS_EVENT_STARTED

Added in API level 3

public static final int GPS_EVENT_STARTED

Event sent when the GPS system has started.

Constant Value: 1 (0x00000001)

GPS_EVENT_STOPPED

Added in API level 3

public static final int GPS_EVENT_STOPPED

Event sent when the GPS system has stopped.

Constant Value: 2 (0x00000002)

Public methods

create

Added in API level 30
Deprecated in API level 24

public static GpsStatus create (GnssStatus gnssStatus, 
                int timeToFirstFix)

Builds a GpsStatus from the given GnssStatus.

Parameters
`gnssStatus`	`GnssStatus`: This value cannot be `null`.
`timeToFirstFix`	`int`

Returns
`GpsStatus`	This value cannot be `null`.

getMaxSatellites

Added in API level 3

public int getMaxSatellites ()

Returns the maximum number of satellites that can be in the satellite list that can be returned by getSatellites().

Returns
`int`	the maximum number of satellites

getSatellites

Added in API level 3

public Iterable<GpsSatellite> getSatellites ()

Returns an array of GpsSatellite objects, which represent the current state of the GPS engine.

Returns
`Iterable<GpsSatellite>`	the list of satellites

getTimeToFirstFix

Added in API level 3

public int getTimeToFirstFix ()

Returns the time required to receive the first fix since the most recent restart of the GPS engine.

Returns
`int`	time to first fix in milliseconds

GpsStatus

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

GPS_EVENT_FIRST_FIX

GPS_EVENT_SATELLITE_STATUS

GPS_EVENT_STARTED

GPS_EVENT_STOPPED

Public methods

create

getMaxSatellites

getSatellites

getTimeToFirstFix