feat(access tracking mode): method to retrieve the current tracking mode

Introduces the possibility to retrieve the current tracking mode that is of type `UserLocationCameraMode`.

Author: benedictstrube

src/ui-mapbox/common.ts

@@ -638,6 +638,8 @@ export interface MapboxApi {
 
     trackUser(options: TrackUserOptions, nativeMap?: any): Promise<void>;
 
+    getUserLocationCameraMode(nativeMap?: any): UserLocationCameraMode;
+
     addSource(id: string, options: AddSourceOptions, nativeMapView?: any): Promise<any>;
 
     updateSource(id: string, options: UpdateSourceOptions, nativeMapView?: any): Promise<any>;
@@ -832,6 +834,8 @@ export interface MapboxViewApi {
 
     trackUser(options: TrackUserOptions): Promise<any>;
 
+    getUserLocationCameraMode(nativeMap?: any): UserLocationCameraMode;
+
     showUserLocationMarker(options): void;
 
     hideUserLocationMarker(options): void;
@@ -1005,6 +1009,9 @@ export abstract class MapboxViewCommonBase extends ContentView implements Mapbox
     trackUser(options: TrackUserOptions): Promise<any> {
         return this.mapbox.trackUser(options, this.getNativeMapView());
     }
+    getUserLocationCameraMode(): UserLocationCameraMode {
+        return this.mapbox.getUserLocationCameraMode(this.getNativeMapView());
+    }
     addSource(id: string, options: AddSourceOptions): Promise<any> {
         return this.mapbox.addSource(id, options, this.getNativeMapView());
     }

src/ui-mapbox/index.android.ts

@@ -2971,6 +2971,36 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
         return renderMode;
     }
 
+    _convertCameraMode( mode: any ): UserLocationCameraMode {
+
+        const modeRef = com.mapbox.mapboxsdk.location.modes.CameraMode;
+
+        switch (mode) {
+            case modeRef.NONE:
+                return "NONE";
+
+            case modeRef.NONE_COMPASS:
+                return "NONE_COMPASS";
+
+            case modeRef.NONE_GPS:
+                return "NONE_GPS";
+
+            case modeRef.TRACKING:
+                return "TRACKING";
+
+            case modeRef.TRACKING_COMPASS:
+                return "TRACKING_COMPASS";
+
+            case modeRef.TRACKING_GPS:
+                return "TRACKING_GPS";
+
+            case modeRef.TRACKING_GPS_NORTH:
+                return "TRACKING_GPS_NORTH";
+        }
+
+        return "NONE";
+    }
+
     _fineLocationPermissionGranted() {
         let hasPermission = android.os.Build.VERSION.SDK_INT < 23; // Android M. (6.0)
 
@@ -3405,4 +3435,16 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
             lng: coordinate.getLongitude()
         }
     }
+
+    getUserLocationCameraMode(nativeMap?: any): UserLocationCameraMode {
+        if (!this._mapboxMapInstance) {
+            return "NONE";
+        }
+
+        if (!this._locationComponent) {
+            return "NONE";
+        }
+
+        return this._convertCameraMode(this._locationComponent.getCameraMode());
+    }
 }

src/ui-mapbox/index.ios.ts

@@ -1821,6 +1821,19 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
         }
     }
 
+    _convertCameraMode(mode: MGLUserTrackingMode): UserLocationCameraMode {
+        switch (mode) {
+            case MGLUserTrackingMode.None:
+                return "NONE";
+            case MGLUserTrackingMode.Follow:
+                return "TRACKING";
+            case MGLUserTrackingMode.FollowWithHeading:
+                return "TRACKING_COMPASS";
+            case MGLUserTrackingMode.FollowWithCourse:
+                return "TRACKING_GPS_NORTH";
+        }
+    }
+
     /**
      * show a user location marker
      *
@@ -3175,6 +3188,16 @@ export class Mapbox extends MapboxCommon implements MapboxApi {
             lng: coordinate.longitude
         }
     }
+
+    getUserLocationCameraMode(nativeMap?: any): UserLocationCameraMode {
+        let theMap: MGLMapView = nativeMap || this._mapboxViewInstance;
+
+        if (!theMap) {
+            return "NONE";
+        }
+
+        return this._convertCameraMode(theMap.userTrackingMode);
+    }
 }
 
 const _addObserver = (eventName, callback) => NSNotificationCenter.defaultCenter.addObserverForNameObjectQueueUsingBlock(eventName, null, NSOperationQueue.mainQueue, callback);