MSMapLocationProvider Class (iOS only)

  • Article
  • 2 minutes to read

A location provider to be used to retrieve user location on iOS.

See MapUserLocation for more details on how to start tracking user location with a location provider.

@interface MSMapLocationProvider : NSObject<CLLocationManagerDelegate>

Constructors

Default constructor

Initializes location provider with the default properties from MSMapLocationProviderBuilder. See MSMapLocationProviderBuilder for more details on what the default properties are.

- (instancetype)init

Customizable Constructor

Initializes location provider with the properties set on the builder inside the passed in block. See MSMapLocationProviderBuilder for more details what properties can be set.

- (instancetype)initWithBuilderBlock:(void (^)(MSMapLocationProviderBuilder*))builderBlock

Example:

[[MSMapLocationProvider alloc] initWithBuilderBlock:^(MSMapLocationProviderBuilder* builder) {
          builder.headingFilter = 3;
          [builder useLastKnownLocationOnLaunch];
}];

Properties

DesiredAccuracy

Refer to MSMapLocationProviderBuilder for information on what desiredAccuracy represents.

If set is called before location retrieval started, setting will be saved for when location retrieval starts. If set is called after location retrieval started, it will restart with the new setting.

@property(nonatomic) CLLocationAccuracy desiredAccuracy

HeadingFilter

Refer to MSMapLocationProviderBuilder for information on what headingFilter represents.

If set is called before location retrieval started, setting will be saved for when location retrieval starts. If set is called after location retrieval started, it will restart with the new setting.

@property(nonatomic) CLLocationDegrees headingFilter

LastLocation

Returns the last location emitted by this location provider, if any. Returns CLLocation.

@property(nonatomic, readonly, nullable) CLLocation* lastLocation

Methods

startTracking

Starts tracking the location on the device. This method may be called multiple times and stopTracking should be called once for each call to startTracking that returns MapUserLocationTrackingStateReady.

- (MSMapUserLocationTrackingState)startTracking

stopTracking

Stops a previous call to start tracking. Must be called once for each call to startTracking that returns MapUserLocationTrackingState.READY.

- (void)stopTracking

Events

LocationChanged

Fired when a location event is received while tracking is active.
removeLocationDidChangeHandler returns false if the listener has not been previously added or has been already removed.

- (MSMapHandlerId)addLocationDidChangeHandler:(MSMapLocationChangedHandler)handler
- (BOOL)removeLocationDidChangeHandler:(MSMapHandlerId)handlerId

See also: MSMapLocationChangedHandler