@capacitor/geolocation 8.0.0-next.2 → 8.0.0-next.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
13
13
  s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
14
14
  s.ios.deployment_target = '15.0'
15
15
  s.dependency 'Capacitor'
16
- s.dependency 'IONGeolocationLib', spec='1.0.1'
16
+ s.dependency 'IONGeolocationLib', spec='2.0.0'
17
17
  s.swift_version = '5.1'
18
18
  end
package/Package.swift CHANGED
@@ -11,7 +11,7 @@ let package = Package(
11
11
  ],
12
12
  dependencies: [
13
13
  .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
14
- .package(url: "https://github.com/ionic-team/ion-ios-geolocation.git", from: "1.0.2")
14
+ .package(url: "https://github.com/ionic-team/ion-ios-geolocation.git", from: "2.0.0")
15
15
  ],
16
16
  targets: [
17
17
  .target(
package/README.md CHANGED
@@ -167,12 +167,13 @@ Not available on web.
167
167
 
168
168
  #### PositionOptions
169
169
 
170
- | Prop | Type | Description | Default | Since |
171
- | --------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
172
- | **`enableHighAccuracy`** | <code>boolean</code> | 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). | <code>false</code> | 1.0.0 |
173
- | **`timeout`** | <code>number</code> | 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`. | <code>10000</code> | 1.0.0 |
174
- | **`maximumAge`** | <code>number</code> | The maximum age in milliseconds of a possible cached position that is acceptable to return | <code>0</code> | 1.0.0 |
175
- | **`minimumUpdateInterval`** | <code>number</code> | 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. | <code>5000</code> | 6.1.0 |
170
+ | Prop | Type | Description | Default | Since |
171
+ | ---------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | ----- |
172
+ | **`enableHighAccuracy`** | <code>boolean</code> | 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). | <code>false</code> | 1.0.0 |
173
+ | **`timeout`** | <code>number</code> | 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`. | <code>10000</code> | 1.0.0 |
174
+ | **`maximumAge`** | <code>number</code> | The maximum age in milliseconds of a possible cached position that is acceptable to return | <code>0</code> | 1.0.0 |
175
+ | **`minimumUpdateInterval`** | <code>number</code> | 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. | <code>5000</code> | 6.1.0 |
176
+ | **`enableLocationFallback`** | <code>boolean</code> | This option applies to Android only. Whether to fall back to the Android framework's `LocationManager` in case Google Play Service's location settings checks fail. This can happen for multiple reasons - e.g. device has no Play Services or device has no network connection (Airplane Mode) If set to `false`, failures are propagated to the caller. Note that `LocationManager` may not be as effective as Google Play Services implementation. If the device's in airplane mode, only the GPS provider is used, which may take longer to return a location, depending on GPS signal. This means that to receive location in such circumstances, you may need to provide a higher timeout. | <code>true</code> | 8.0.0 |
176
177
 
177
178
 
178
179
  #### ClearWatchOptions
@@ -237,10 +238,11 @@ The following table list all the plugin errors:
237
238
  | OS-PLUG-GLOC-0007 | Android, iOS | Location services are not enabled. |
238
239
  | OS-PLUG-GLOC-0008 | iOS | Application's use of location services was restricted. |
239
240
  | OS-PLUG-GLOC-0009 | Android | Request to enable location was denied. |
240
- | OS-PLUG-GLOC-0010 | Android | Could not obtain location in time. Try with a higher timeout. |
241
+ | OS-PLUG-GLOC-0010 | Android, iOS | Could not obtain location in time. Try with a higher timeout. |
241
242
  | OS-PLUG-GLOC-0011 | Android | Timeout needs to be a positive value. |
242
243
  | OS-PLUG-GLOC-0012 | Android | WatchId not found. |
243
244
  | OS-PLUG-GLOC-0013 | Android | WatchId needs to be provided. |
244
245
  | OS-PLUG-GLOC-0014 | Android | Google Play Services error user resolvable. |
245
246
  | OS-PLUG-GLOC-0015 | Android | Google Play Services error. |
246
247
  | OS-PLUG-GLOC-0016 | Android | Location settings error. |
248
+ | OS-PLUG-GLOC-0017 | Android | Unable to retrieve location because device has both Network and Location turned off. |
@@ -58,7 +58,7 @@ repositories {
58
58
 
59
59
  dependencies {
60
60
  implementation fileTree(dir: 'libs', include: ['*.jar'])
61
- implementation("io.ionic.libs:iongeolocation-android:1.0.0")
61
+ implementation("io.ionic.libs:iongeolocation-android:2.0.0")
62
62
  implementation project(':capacitor-android')
63
63
  implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
64
64
 
@@ -68,4 +68,9 @@ object GeolocationErrors {
68
68
  code = formatErrorCode(16),
69
69
  message = "Location settings error."
70
70
  )
71
+
72
+ val NETWORK_LOCATION_DISABLED_ERROR = ErrorInfo(
73
+ code = formatErrorCode(17),
74
+ message = "Unable to retrieve location because device has both Network and Location turned off."
75
+ )
71
76
  }
@@ -54,11 +54,7 @@ class GeolocationPlugin : Plugin() {
54
54
  }
55
55
  }
56
56
 
57
- this.controller = IONGLOCController(
58
- LocationServices.getFusedLocationProviderClient(context),
59
- activityLauncher
60
- )
61
-
57
+ this.controller = IONGLOCController(context, activityLauncher)
62
58
  }
63
59
 
64
60
  override fun handleOnDestroy() {
@@ -82,7 +78,7 @@ class GeolocationPlugin : Plugin() {
82
78
  * @param onLocationEnabled lambda function to use in case location services are enabled
83
79
  */
84
80
  private fun checkLocationState(call: PluginCall, onLocationEnabled: () -> Unit) {
85
- if (controller.areLocationServicesEnabled(context)) {
81
+ if (controller.areLocationServicesEnabled()) {
86
82
  onLocationEnabled()
87
83
  } else {
88
84
  call.sendError(GeolocationErrors.LOCATION_DISABLED)
@@ -279,6 +275,9 @@ class GeolocationPlugin : Plugin() {
279
275
  is IONGLOCException.IONGLOCSettingsException -> {
280
276
  call.sendError(GeolocationErrors.LOCATION_SETTINGS_ERROR)
281
277
  }
278
+ is IONGLOCException.IONGLOCLocationAndNetworkDisabledException -> {
279
+ call.sendError(GeolocationErrors.NETWORK_LOCATION_DISABLED_ERROR)
280
+ }
282
281
  is IONGLOCException.IONGLOCInvalidTimeoutException -> {
283
282
  call.sendError(GeolocationErrors.INVALID_TIMEOUT)
284
283
  }
@@ -330,8 +329,15 @@ class GeolocationPlugin : Plugin() {
330
329
  val maximumAge = call.getNumber("maximumAge", 0)
331
330
  val enableHighAccuracy = call.getBoolean("enableHighAccuracy", false) ?: false
332
331
  val minimumUpdateInterval = call.getNumber("minimumUpdateInterval", 5000)
333
-
334
- val locationOptions = IONGLOCLocationOptions(timeout, maximumAge, enableHighAccuracy, minimumUpdateInterval)
332
+ val enableLocationFallback = call.getBoolean("enableLocationFallback", true) ?: true
333
+
334
+ val locationOptions = IONGLOCLocationOptions(
335
+ timeout,
336
+ maximumAge,
337
+ enableHighAccuracy,
338
+ enableLocationFallback,
339
+ minimumUpdateInterval
340
+ )
335
341
 
336
342
  return locationOptions
337
343
  }
package/dist/docs.json CHANGED
@@ -230,6 +230,22 @@
230
230
  "docs": "The minumum update interval for location updates.\n\nIf location updates are available faster than this interval then an update\nwill only occur if the minimum update interval has expired since the last location update.\n\nThis parameter is only available for Android. It has no effect on iOS or Web platforms.",
231
231
  "complexTypes": [],
232
232
  "type": "number | undefined"
233
+ },
234
+ {
235
+ "name": "enableLocationFallback",
236
+ "tags": [
237
+ {
238
+ "text": "true",
239
+ "name": "default"
240
+ },
241
+ {
242
+ "text": "8.0.0",
243
+ "name": "since"
244
+ }
245
+ ],
246
+ "docs": "This option applies to Android only.\n\nWhether to fall back to the Android framework's `LocationManager` in case Google Play Service's location settings checks fail.\nThis can happen for multiple reasons - e.g. device has no Play Services or device has no network connection (Airplane Mode)\nIf set to `false`, failures are propagated to the caller.\nNote that `LocationManager` may not be as effective as Google Play Services implementation.\nIf the device's in airplane mode, only the GPS provider is used, which may take longer to return a location, depending on GPS signal.\nThis means that to receive location in such circumstances, you may need to provide a higher timeout.",
247
+ "complexTypes": [],
248
+ "type": "boolean | undefined"
233
249
  }
234
250
  ]
235
251
  },
@@ -168,6 +168,20 @@ export interface PositionOptions {
168
168
  * @since 6.1.0
169
169
  */
170
170
  minimumUpdateInterval?: number;
171
+ /**
172
+ * This option applies to Android only.
173
+ *
174
+ * Whether to fall back to the Android framework's `LocationManager` in case Google Play Service's location settings checks fail.
175
+ * This can happen for multiple reasons - e.g. device has no Play Services or device has no network connection (Airplane Mode)
176
+ * If set to `false`, failures are propagated to the caller.
177
+ * Note that `LocationManager` may not be as effective as Google Play Services implementation.
178
+ * If the device's in airplane mode, only the GPS provider is used, which may take longer to return a location, depending on GPS signal.
179
+ * This means that to receive location in such circumstances, you may need to provide a higher timeout.
180
+ *
181
+ * @default true
182
+ * @since 8.0.0
183
+ */
184
+ enableLocationFallback?: boolean;
171
185
  }
172
186
  export type WatchPositionCallback = (position: Position | null, err?: any) => void;
173
187
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState } from '@capacitor/core';\n\nexport type CallbackID = string;\n\nexport interface PermissionStatus {\n /**\n * Permission state for location alias.\n *\n * On Android it requests/checks both ACCESS_COARSE_LOCATION and\n * ACCESS_FINE_LOCATION permissions.\n *\n * On iOS and web it requests/checks location permission.\n *\n * @since 1.0.0\n */\n location: PermissionState;\n\n /**\n * Permission state for coarseLocation alias.\n *\n * On Android it requests/checks ACCESS_COARSE_LOCATION.\n *\n * On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) or\n * Precise location (ACCESS_FINE_LOCATION), so this alias can be used if the app doesn't\n * need high accuracy.\n *\n * On iOS and web it will have the same value as location alias.\n *\n * @since 1.2.0\n */\n coarseLocation: PermissionState;\n}\n\nexport type GeolocationPermissionType = 'location' | 'coarseLocation';\n\nexport interface GeolocationPluginPermissions {\n permissions: GeolocationPermissionType[];\n}\n\nexport interface GeolocationPlugin {\n /**\n * Get the current GPS location of the device\n *\n * @since 1.0.0\n */\n getCurrentPosition(options?: PositionOptions): Promise<Position>;\n\n /**\n * Set up a watch for location changes. Note that watching for location changes\n * can consume a large amount of energy. Be smart about listening only when you need to.\n *\n * @since 1.0.0\n */\n watchPosition(options: PositionOptions, callback: WatchPositionCallback): Promise<CallbackID>;\n\n /**\n * Clear a given watch\n *\n * @since 1.0.0\n */\n clearWatch(options: ClearWatchOptions): Promise<void>;\n\n /**\n * Check location permissions. Will throw if system location services are disabled.\n *\n * @since 1.0.0\n */\n checkPermissions(): Promise<PermissionStatus>;\n\n /**\n * Request location permissions. Will throw if system location services are disabled.\n *\n * Not available on web.\n *\n * @since 1.0.0\n */\n requestPermissions(permissions?: GeolocationPluginPermissions): Promise<PermissionStatus>;\n}\n\nexport interface ClearWatchOptions {\n id: CallbackID;\n}\n\nexport interface Position {\n /**\n * Creation timestamp for coords\n *\n * @since 1.0.0\n */\n timestamp: number;\n\n /**\n * The GPS coordinates along with the accuracy of the data\n *\n * @since 1.0.0\n */\n coords: {\n /**\n * Latitude in decimal degrees\n *\n * @since 1.0.0\n */\n latitude: number;\n\n /**\n * longitude in decimal degrees\n *\n * @since 1.0.0\n */\n longitude: number;\n\n /**\n * Accuracy level of the latitude and longitude coordinates in meters\n *\n * @since 1.0.0\n */\n accuracy: number;\n\n /**\n * Accuracy level of the altitude coordinate in meters, if available.\n *\n * Available on all iOS versions and on Android 8.0+.\n *\n * @since 1.0.0\n */\n altitudeAccuracy: number | null | undefined;\n\n /**\n * The altitude the user is at (if available)\n *\n * @since 1.0.0\n */\n altitude: number | null;\n\n /**\n * The speed the user is traveling (if available)\n *\n * @since 1.0.0\n */\n speed: number | null;\n\n /**\n * The heading the user is facing (if available)\n *\n * @since 1.0.0\n */\n heading: number | null;\n };\n}\n\nexport interface PositionOptions {\n /**\n * High accuracy mode (such as GPS, if available)\n *\n * On Android 12+ devices it will be ignored if users didn't grant\n * ACCESS_FINE_LOCATION permissions (can be checked with location alias).\n *\n * @default false\n * @since 1.0.0\n */\n enableHighAccuracy?: boolean;\n\n /**\n * The maximum wait time in milliseconds for location updates.\n *\n * In Android, since version 7.1.0 of the plugin, it is also used to determine the\n * interval of location updates for `watchPosition`.\n *\n * @default 10000\n * @since 1.0.0\n */\n timeout?: number;\n\n /**\n * The maximum age in milliseconds of a possible cached position that is acceptable to return\n *\n * @default 0\n * @since 1.0.0\n */\n maximumAge?: number;\n\n /**\n * The minumum update interval for location updates.\n *\n * If location updates are available faster than this interval then an update\n * will only occur if the minimum update interval has expired since the last location update.\n *\n * This parameter is only available for Android. It has no effect on iOS or Web platforms.\n *\n * @default 5000\n * @since 6.1.0\n */\n minimumUpdateInterval?: number;\n}\n\nexport type WatchPositionCallback = (position: Position | null, err?: any) => void;\n\n/**\n * @deprecated Use `PositionOptions`.\n * @since 1.0.0\n */\nexport type GeolocationOptions = PositionOptions;\n\n/**\n * @deprecated Use `WatchPositionCallback`.\n * @since 1.0.0\n */\nexport type GeolocationWatchCallback = WatchPositionCallback;\n\n/**\n * @deprecated Use `Position`.\n * @since 1.0.0\n */\nexport type GeolocationPosition = Position;\n"]}
1
+ {"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PermissionState } from '@capacitor/core';\n\nexport type CallbackID = string;\n\nexport interface PermissionStatus {\n /**\n * Permission state for location alias.\n *\n * On Android it requests/checks both ACCESS_COARSE_LOCATION and\n * ACCESS_FINE_LOCATION permissions.\n *\n * On iOS and web it requests/checks location permission.\n *\n * @since 1.0.0\n */\n location: PermissionState;\n\n /**\n * Permission state for coarseLocation alias.\n *\n * On Android it requests/checks ACCESS_COARSE_LOCATION.\n *\n * On Android 12+, users can choose between Approximate location (ACCESS_COARSE_LOCATION) or\n * Precise location (ACCESS_FINE_LOCATION), so this alias can be used if the app doesn't\n * need high accuracy.\n *\n * On iOS and web it will have the same value as location alias.\n *\n * @since 1.2.0\n */\n coarseLocation: PermissionState;\n}\n\nexport type GeolocationPermissionType = 'location' | 'coarseLocation';\n\nexport interface GeolocationPluginPermissions {\n permissions: GeolocationPermissionType[];\n}\n\nexport interface GeolocationPlugin {\n /**\n * Get the current GPS location of the device\n *\n * @since 1.0.0\n */\n getCurrentPosition(options?: PositionOptions): Promise<Position>;\n\n /**\n * Set up a watch for location changes. Note that watching for location changes\n * can consume a large amount of energy. Be smart about listening only when you need to.\n *\n * @since 1.0.0\n */\n watchPosition(options: PositionOptions, callback: WatchPositionCallback): Promise<CallbackID>;\n\n /**\n * Clear a given watch\n *\n * @since 1.0.0\n */\n clearWatch(options: ClearWatchOptions): Promise<void>;\n\n /**\n * Check location permissions. Will throw if system location services are disabled.\n *\n * @since 1.0.0\n */\n checkPermissions(): Promise<PermissionStatus>;\n\n /**\n * Request location permissions. Will throw if system location services are disabled.\n *\n * Not available on web.\n *\n * @since 1.0.0\n */\n requestPermissions(permissions?: GeolocationPluginPermissions): Promise<PermissionStatus>;\n}\n\nexport interface ClearWatchOptions {\n id: CallbackID;\n}\n\nexport interface Position {\n /**\n * Creation timestamp for coords\n *\n * @since 1.0.0\n */\n timestamp: number;\n\n /**\n * The GPS coordinates along with the accuracy of the data\n *\n * @since 1.0.0\n */\n coords: {\n /**\n * Latitude in decimal degrees\n *\n * @since 1.0.0\n */\n latitude: number;\n\n /**\n * longitude in decimal degrees\n *\n * @since 1.0.0\n */\n longitude: number;\n\n /**\n * Accuracy level of the latitude and longitude coordinates in meters\n *\n * @since 1.0.0\n */\n accuracy: number;\n\n /**\n * Accuracy level of the altitude coordinate in meters, if available.\n *\n * Available on all iOS versions and on Android 8.0+.\n *\n * @since 1.0.0\n */\n altitudeAccuracy: number | null | undefined;\n\n /**\n * The altitude the user is at (if available)\n *\n * @since 1.0.0\n */\n altitude: number | null;\n\n /**\n * The speed the user is traveling (if available)\n *\n * @since 1.0.0\n */\n speed: number | null;\n\n /**\n * The heading the user is facing (if available)\n *\n * @since 1.0.0\n */\n heading: number | null;\n };\n}\n\nexport interface PositionOptions {\n /**\n * High accuracy mode (such as GPS, if available)\n *\n * On Android 12+ devices it will be ignored if users didn't grant\n * ACCESS_FINE_LOCATION permissions (can be checked with location alias).\n *\n * @default false\n * @since 1.0.0\n */\n enableHighAccuracy?: boolean;\n\n /**\n * The maximum wait time in milliseconds for location updates.\n *\n * In Android, since version 7.1.0 of the plugin, it is also used to determine the\n * interval of location updates for `watchPosition`.\n *\n * @default 10000\n * @since 1.0.0\n */\n timeout?: number;\n\n /**\n * The maximum age in milliseconds of a possible cached position that is acceptable to return\n *\n * @default 0\n * @since 1.0.0\n */\n maximumAge?: number;\n\n /**\n * The minumum update interval for location updates.\n *\n * If location updates are available faster than this interval then an update\n * will only occur if the minimum update interval has expired since the last location update.\n *\n * This parameter is only available for Android. It has no effect on iOS or Web platforms.\n *\n * @default 5000\n * @since 6.1.0\n */\n minimumUpdateInterval?: number;\n\n /**\n * This option applies to Android only.\n *\n * Whether to fall back to the Android framework's `LocationManager` in case Google Play Service's location settings checks fail.\n * This can happen for multiple reasons - e.g. device has no Play Services or device has no network connection (Airplane Mode)\n * If set to `false`, failures are propagated to the caller.\n * Note that `LocationManager` may not be as effective as Google Play Services implementation.\n * If the device's in airplane mode, only the GPS provider is used, which may take longer to return a location, depending on GPS signal.\n * This means that to receive location in such circumstances, you may need to provide a higher timeout.\n *\n * @default true\n * @since 8.0.0\n */\n enableLocationFallback?: boolean;\n}\n\nexport type WatchPositionCallback = (position: Position | null, err?: any) => void;\n\n/**\n * @deprecated Use `PositionOptions`.\n * @since 1.0.0\n */\nexport type GeolocationOptions = PositionOptions;\n\n/**\n * @deprecated Use `WatchPositionCallback`.\n * @since 1.0.0\n */\nexport type GeolocationWatchCallback = WatchPositionCallback;\n\n/**\n * @deprecated Use `Position`.\n * @since 1.0.0\n */\nexport type GeolocationPosition = Position;\n"]}
@@ -24,6 +24,7 @@ final class GeolocationCallbackManager {
24
24
  private(set) var requestPermissionsCallbacks: [CAPPluginCall]
25
25
  private(set) var locationCallbacks: [CAPPluginCall]
26
26
  private(set) var watchCallbacks: [String: CAPPluginCall]
27
+ private(set) var timeout: Int?
27
28
  private let capacitorBridge: CAPBridgeProtocol?
28
29
 
29
30
  private var allCallbackGroups: [GeolocationCallbackGroup] {
@@ -52,11 +53,15 @@ final class GeolocationCallbackManager {
52
53
  func addLocationCallback(capacitorCall call: CAPPluginCall) {
53
54
  capacitorBridge?.saveCall(call)
54
55
  locationCallbacks.append(call)
56
+ let timeout = call.getInt(Constants.Arguments.timeout)
57
+ self.timeout = timeout
55
58
  }
56
59
 
57
60
  func addWatchCallback(_ watchId: String, capacitorCall call: CAPPluginCall) {
58
61
  capacitorBridge?.saveCall(call)
59
62
  watchCallbacks[watchId] = call
63
+ let timeout = call.getInt(Constants.Arguments.timeout)
64
+ self.timeout = timeout
60
65
  }
61
66
 
62
67
  func clearRequestPermissionsCallbacks() {
@@ -109,6 +114,10 @@ final class GeolocationCallbackManager {
109
114
 
110
115
  func sendError(_ error: GeolocationError) {
111
116
  createPluginResult(status: .error(error.toCodeMessagePair()))
117
+
118
+ if case .timeout = error {
119
+ watchCallbacks.keys.forEach { clearWatchCallbackIfExists($0) }
120
+ }
112
121
  }
113
122
  }
114
123
 
@@ -2,6 +2,7 @@ enum Constants {
2
2
  enum Arguments {
3
3
  static let enableHighAccuracy = "enableHighAccuracy"
4
4
  static let id = "id"
5
+ static let timeout = "timeout"
5
6
  }
6
7
 
7
8
  enum AuthorisationStatus {
@@ -10,6 +10,7 @@ enum GeolocationError: Error {
10
10
  case permissionRestricted
11
11
  case positionUnavailable
12
12
  case inputArgumentsIssue(target: GeolocationMethod)
13
+ case timeout
13
14
 
14
15
  func toCodeMessagePair() -> (String, String) {
15
16
  ("OS-PLUG-GLOC-\(String(format: "%04d", code))", description)
@@ -29,16 +30,18 @@ private extension GeolocationError {
29
30
  case .watchPosition: 5
30
31
  case .clearWatch: 6
31
32
  }
33
+ case .timeout: 10
32
34
  }
33
35
  }
34
36
 
35
37
  var description: String {
36
38
  switch self {
37
- case .positionUnavailable: "There was en error trying to obtain the location."
39
+ case .positionUnavailable: "There was an error trying to obtain the location."
38
40
  case .permissionDenied: "Location permission request was denied."
39
41
  case .locationServicesDisabled: "Location services are not enabled."
40
42
  case .permissionRestricted: "Application's use of location services was restricted."
41
43
  case .inputArgumentsIssue(let target): "The '\(target.rawValue)' input parameters aren't valid."
44
+ case .timeout: "Could not obtain location in time. Try with a higher timeout."
42
45
  }
43
46
  }
44
47
  }
@@ -1,7 +1,6 @@
1
1
  import Capacitor
2
2
  import IONGeolocationLib
3
3
  import UIKit
4
-
5
4
  import Combine
6
5
 
7
6
  @objc(GeolocationPlugin)
@@ -19,6 +18,7 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
19
18
  private var locationService: (any IONGLOCService)?
20
19
  private var cancellables = Set<AnyCancellable>()
21
20
  private var locationCancellable: AnyCancellable?
21
+ private var timeoutCancellable: AnyCancellable?
22
22
  private var callbackManager: GeolocationCallbackManager?
23
23
  private var statusInitialized = false
24
24
  private var locationInitialized: Bool = false
@@ -26,7 +26,7 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
26
26
  override public func load() {
27
27
  self.locationService = IONGLOCManagerWrapper()
28
28
  self.callbackManager = .init(capacitorBridge: bridge)
29
-
29
+
30
30
  NotificationCenter.default.addObserver(
31
31
  self,
32
32
  selector: #selector(appDidBecomeActive),
@@ -40,8 +40,10 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
40
40
  print("App became active. Restarting location monitoring for watch callbacks.")
41
41
  locationCancellable?.cancel()
42
42
  locationCancellable = nil
43
+ timeoutCancellable?.cancel()
44
+ timeoutCancellable = nil
43
45
  locationInitialized = false
44
-
46
+
45
47
  locationService?.stopMonitoringLocation()
46
48
  locationService?.startMonitoringLocation()
47
49
  bindLocationPublisher()
@@ -77,6 +79,8 @@ public class GeolocationPlugin: CAPPlugin, CAPBridgedPlugin {
77
79
  locationService?.stopMonitoringLocation()
78
80
  locationCancellable?.cancel()
79
81
  locationCancellable = nil
82
+ timeoutCancellable?.cancel()
83
+ timeoutCancellable = nil
80
84
  locationInitialized = false
81
85
  }
82
86
 
@@ -145,7 +149,7 @@ private extension GeolocationPlugin {
145
149
  locationCancellable = locationService?.currentLocationPublisher
146
150
  .catch { [weak self] error -> AnyPublisher<IONGLOCPositionModel, Never> in
147
151
  print("An error was found while retrieving the location: \(error)")
148
-
152
+
149
153
  if case IONGLOCLocationError.locationUnavailable = error {
150
154
  print("Location unavailable (likely due to backgrounding). Keeping watch callbacks alive.")
151
155
  self?.callbackManager?.sendError(.positionUnavailable)
@@ -160,6 +164,15 @@ private extension GeolocationPlugin {
160
164
  .sink(receiveValue: { [weak self] position in
161
165
  self?.callbackManager?.sendSuccess(with: position)
162
166
  })
167
+
168
+ timeoutCancellable = locationService?.locationTimeoutPublisher
169
+ .sink(receiveValue: { [weak self] error in
170
+ if case .timeout = error {
171
+ self?.callbackManager?.sendError(.timeout)
172
+ } else {
173
+ self?.callbackManager?.sendError(.positionUnavailable)
174
+ }
175
+ })
163
176
  }
164
177
 
165
178
  func requestLocationAuthorisation(type requestType: IONGLOCAuthorisationRequestType) {
@@ -200,10 +213,10 @@ private extension GeolocationPlugin {
200
213
  callbackManager?.sendRequestPermissionsSuccess(Constants.AuthorisationStatus.Status.granted)
201
214
  }
202
215
  if shouldRequestCurrentPosition {
203
- locationService?.requestSingleLocation()
216
+ locationService?.requestSingleLocation(options: IONGLOCRequestOptionsModel(timeout: callbackManager?.timeout))
204
217
  }
205
218
  if shouldRequestLocationMonitoring {
206
- locationService?.startMonitoringLocation()
219
+ locationService?.startMonitoringLocation(options: IONGLOCRequestOptionsModel(timeout: callbackManager?.timeout))
207
220
  }
208
221
  }
209
222
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@capacitor/geolocation",
3
- "version": "8.0.0-next.2",
3
+ "version": "8.0.0-next.4",
4
4
  "description": "The Geolocation API provides simple methods for getting and tracking the current position of the device using GPS, along with altitude, heading, and speed information if available.",
5
5
  "main": "dist/plugin.cjs.js",
6
6
  "module": "dist/esm/index.js",
@@ -59,15 +59,15 @@
59
59
  "@semantic-release/changelog": "^6.0.3",
60
60
  "@semantic-release/exec": "^7.1.0",
61
61
  "@semantic-release/git": "^10.0.1",
62
- "@semantic-release/github": "^11.0.1",
63
- "@semantic-release/npm": "^12.0.1",
62
+ "@semantic-release/github": "^12.0.0",
63
+ "@semantic-release/npm": "^13.1.1",
64
64
  "@types/node": "^20.14.8",
65
65
  "eslint": "^8.57.0",
66
66
  "prettier": "^3.3.3",
67
67
  "prettier-plugin-java": "^2.6.4",
68
68
  "rimraf": "^6.0.1",
69
69
  "rollup": "^2.78.1",
70
- "semantic-release": "^24.0.0",
70
+ "semantic-release": "^25.0.1",
71
71
  "swiftlint": "^2.0.0",
72
72
  "typescript": "~5.4.5"
73
73
  },