Class YMKLocationManager

Handles location updates and changes.

Instance Methods

- requestSingleUpdateWithLocationListener:

Subscribe to a single location update.

- resume

Resumes updates stopped by a suspend call.

- subscribeForLocationUpdatesWithDesiredAccuracy:minTime:minDistance:allowUseInBackground:filteringMode:locationListener:

Subscribe for location update events.

- suspend

Stops updates for all subscriptions until resume is called.

- unsubscribeWithLocationListener:

Unsubscribe from location update events.

Class Methods

Method Detail

+lastKnownLocation

+ (YMKLocation *)lastKnownLocation

-requestSingleUpdateWithLocationListener:

- (void)requestSingleUpdateWithLocationListener:(nonnull id< YMKLocationDelegate >)locationListener 

Subscribe to a single location update.

If the listener was already subscribed to location updates, the previous subscription will be removed.
Parameters:
locationListener

Location update listener.

-resume

- (void)resume

Resumes updates stopped by a suspend call.

-subscribeForLocationUpdatesWithDesiredAccuracy:minTime:minDistance:allowUseInBackground:filteringMode:locationListener:

- (void)subscribeForLocationUpdatesWithDesiredAccuracy:(double)desiredAccuracy
                                               minTime:(long long)minTime
                                           minDistance:(double)minDistance
                                  allowUseInBackground:(BOOL)allowUseInBackground
                                         filteringMode:(YMKLocationFilteringMode)filteringMode
                                      locationListener:(nonnull id< YMKLocationDelegate >)locationListener 

Subscribe for location update events.

If the listener was already subscribed to updates from the LocationManager, subscription settings will be updated. Use desiredAccuracy = 0 to obtain best possible accuracy, minTime = 0 to ignore minTime and use minDistance instead, minDistance = 0 to use only minTime. If both minTime and minDistance are set to zero, the subscription will use the same settings as other LocationManager clients.
Parameters:
desiredAccuracy

Desired location accuracy, in meters. This value is used to configure location services provided by the host OS. If locations with the desired accuracy are not available, updates may be called with lower accuracy.

minTime

Minimal time interval between events, in milliseconds.

minDistance

Minimal distance between location updates, in meters.

allowUseInBackground

Defines whether the subscription can continue to fetch notifications when the application is inactive. If allowUseInBackground is true, set the location flag in UIBackgroundModes for your application.

filteringMode

Defines whether locations should be filtered.

locationListener

Location update listener.

-suspend

- (void)suspend

Stops updates for all subscriptions until resume is called.

-unsubscribeWithLocationListener:

- (void)unsubscribeWithLocationListener:(nonnull id< YMKLocationDelegate >)locationListener 

Unsubscribe from location update events.

Can be called for either subscribeForLocationUpdates() or requestSingleUpdate(). For requestSingleUpdate(), if an event was already received, unsubscribe() does not have any effect. If the listener is already unsubscribed, the method call is ignored.
Parameters:
locationListener

Listener passed to either subscribeForLocationUpdates() or requestSingleUpdate().