<MPPositionProvider> Protocol Reference

#include <MPPositionProvider.h>

Inheritance diagram for <MPPositionProvider>:

Instance Methods
(void)	- requestLocationPermissions
(void)	- updateLocationPermissionStatus
(void)	- startPositioning:
(void)	- stopPositioning:
(void)	- startPositioningAfter:arg:
(BOOL)	- isRunning

Properties
BOOL	preferAlwaysLocationPermission
BOOL	locationServicesActive
id< MPPositionProviderDelegate >	delegate
MPPositionResult *	latestPositionResult
MPPositionProviderType	providerType

Detailed Description

Protocol specifying how an indoor positioning provider should be implemented if the users location is to be exposed to MPMapControl

Method Documentation

isRunning

- (BOOL) isRunning

The running state of the provider

Returns

The running state. YES means the provider is running.

requestLocationPermissions

- (void) requestLocationPermissions

Request location services permissions

startPositioning:

- (void) startPositioning:

(nullable NSString *)

arg

Start the provider. The argument value is depending on the implementation.

Parameters

arg	The argument value is depending on the implementation

startPositioningAfter:arg:

- (void) startPositioningAfter:		(int)	millis
arg:		(nullable NSString *)	arg

Start the provider after specified number of milliseconds. The argument value is depending on the implementation.

Parameters

millis	The number of milliseconds before the provider will start
arg	The argument value is depending on the implementation

stopPositioning:

- (void) stopPositioning:

(nullable NSString *)

arg

Stop the provider. The argument value is depending on the implementation.

Parameters

arg	The argument value is depending on the implementation

updateLocationPermissionStatus

- (void) updateLocationPermissionStatus

Update location services permission status

Property Documentation

delegate

- (id<MPPositionProviderDelegate>) delegate

readwritenonatomicweak

Delegate object. The receiver of user positions.

latestPositionResult

- (MPPositionResult*) latestPositionResult

readwritenonatomicstrong

Latest position result if any.

locationServicesActive

- (BOOL) locationServicesActive

readnonatomicassign

Get location services activity status

preferAlwaysLocationPermission

- (BOOL) preferAlwaysLocationPermission

readwritenonatomicassign

Set location services flag that determines if app should request location always or only when in use

providerType

- (MPPositionProviderType) providerType

readwritenonatomicassign

Provider type stored as an integer. Currently not used by MPMapControl.