Hierarchy

• PositionOptions

  ↳ GeolocationOptions

Table of contents

Properties

• doNotShowFailureMessage
• enableHighAccuracy
• getMeFallbackGps
• maximumAge
• minimumUpdateInterval
• timeout

Properties

doNotShowFailureMessage

• Optional doNotShowFailureMessage: boolean

---

enableHighAccuracy

• Optional enableHighAccuracy: boolean

High accuracy mode (such as GPS, if available)

On Android 12+ devices it will be ignored if users didn't grant ACCESS_FINE_LOCATION permissions (can be checked with location alias).

Default

false

Since

1.0.0

Inherited from

PositionOptions.enableHighAccuracy

---

getMeFallbackGps

• Optional getMeFallbackGps: boolean

---

maximumAge

• Optional maximumAge: number

The maximum age in milliseconds of a possible cached position that is acceptable to return

Default

0

Since

1.0.0

Inherited from

PositionOptions.maximumAge

---

minimumUpdateInterval

• Optional minimumUpdateInterval: number

The minumum update interval for location updates.

If location updates are available faster than this interval then an update will only occur if the minimum update interval has expired since the last location update.

This parameter is only available for Android. It has no effect on iOS or Web platforms.

Default

5000

Since

6.1.0

Inherited from

PositionOptions.minimumUpdateInterval

---

timeout

• Optional timeout: number

The maximum wait time in milliseconds for location updates.

In Android, since version 7.1.0 of the plugin, it is also used to determine the interval of location updates for watchPosition.

Default

10000

Since

1.0.0

Inherited from

PositionOptions.timeout