LocationControllerInterface Protocol Reference
LocationControllerInterface
public protocol LocationControllerInterface-
Whether position has initialized
Declaration
Swift
func hasInit() -> BoolReturn Value
true if position is available
-
Get the current zone
Declaration
Swift
func getCurrentZone() -> MNZone?Return Value
Current zone, nil if not available
-
Get the current position
Declaration
Swift
func getPosition() -> MNPosition?Return Value
Current position, nil if not available
-
Returns a list of entities nearby the user’s position. Empty if none available
Declaration
Swift
func getNearbyEntities(completion: @escaping ([EntityZoneDistance]) -> ())Return Value
List of nearby entities
-
Get a list of nearby properties
Declaration
Swift
func getNearbyProperties() -> Set<Int>Return Value
A unique list of nearby properties
-
Add a listener to changes in Nearby Property List
Declaration
Swift
func addNearbyPropertiesListener(listener: NearbyPropertiesListener)Parameters
listenerA listener to changes in Nearby Properties
-
Remove listener from changes in Nearby Property List
Declaration
Swift
func removeNearbyPropertiesListener(listener: NearbyPropertiesListener)Parameters
listenerA listener to changes in Nearby Properties
-
Declaration
Swift
func getValidBlueDotStatus() -> EnumValidBlueDotError -
Declaration
Swift
func addValidBlueDotStatusChangeListener(listener: ValidBlueDotCallbackListener) -
Declaration
Swift
func removeValidBlueDotStatusChangeListener(listener: ValidBlueDotCallbackListener) -
Declaration
Swift
func getValidBlueDotErrorType() -> EnumValidBlueDotError -
Add a listener to changes in Position visibility
Declaration
Swift
func addPositionVisibilityListener(listener: PositionVisibilityListener)Parameters
listenerA listener to changes in position visibility
-
Remove listener from changes in Position visibility
Declaration
Swift
func removePositionVisibilityListener(listener: PositionVisibilityListener)Parameters
listenerA listener to changes in position visibility
-
Declaration
Swift
func getPositionVisibility() -> Bool? -
Add a listener to changes in Position
Declaration
Swift
func addPositionChangeListener(listener: PositionChangeListener)Parameters
listenerA listener to changes in position
-
Remove listener from changes in Position
Declaration
Swift
func removePositionChangeListener(listener: PositionChangeListener)Parameters
listenerA listener to changes in position
-
Add a listener to changes in Position animation
Declaration
Swift
func addPositionAnimationListener(listener: PositionAnimationListener)Parameters
listenerA listener to changes in position animation
-
Remove listener from changes in Position animation
Declaration
Swift
func removePositionAnimationListener(listener: PositionAnimationListener)Parameters
listenerA listener to changes in position animation
-
When enabled, if the user is in navigation mode and the blue dot is nearby the routing path, it will attempt to snap the blue dot to the routing path
Declaration
Swift
func enableSnapBlueDotToRoute(enable: Bool)Parameters
enablewhether or not to enable the feature
-
Check if snapping blue dot to route path feature is enabled
Declaration
Swift
func isSnapBlueDotToRouteEnabled() -> BoolReturn Value
Whether or not the snapping blue dot to route path feature is enabled
-
Gets the last known value of the phone heading
Declaration
Swift
func getLastKnownPhoneHeading() -> Float?Return Value
Last known value of phone heading in radians
-
Add a listener to changes in phone heading value
Declaration
Swift
func addPhoneHeadingChangeListener(listener: PhoneHeadingChangeListener)Parameters
listenerA listener to changes in phone heading value
-
Remove listener from changes in phone heading value
Declaration
Swift
func removePhoneHeadingChangeListener(listener: PhoneHeadingChangeListener)Parameters
listenerA listener to changes in phone heading value
-
Add a listener to changes in phone heading accuracy value
Declaration
Swift
func addPhoneHeadingAccuracyChangeListener(listener: PhoneHeadingAccuracyChangeListener)Parameters
listenerA listener to changes in phone heading accuracy value
-
Remove listener from changes in phone heading accuracy value
Declaration
Swift
func removePhoneHeadingAccuracyChangeListener(listener: PhoneHeadingAccuracyChangeListener)Parameters
listenerA listener to changes in phone heading accuracy value
-
Declaration
Swift
func getLastKnownPhoneHeadingAccuracy() -> MNConfidence -
Gets the last known value of the user heading
Declaration
Swift
func getLastKnownUserHeading() -> Float?Return Value
Last known value of user heading in radians
-
Add a listener to changes in user heading value
Declaration
Swift
func addUserHeadingChangeListener(listener: UserHeadingChangeListener)Parameters
listenerA listener to changes in phone heading value
-
Remove listener from changes in user heading value
Declaration
Swift
func removeUserHeadingChangeListener(listener: UserHeadingChangeListener)Parameters
listenerA listener to changes in user heading value
-
Gets the last known value of the fused user heading
Declaration
Swift
func getLastKnownFusedUserHeading() -> Float?Return Value
Last known value of fused user heading in radians
-
Add a listener to changes in fused user heading value
Declaration
Swift
func addFusedUserHeadingChangeListener(listener: FusedUserHeadingChangeListener)Parameters
listenerA listener to changes in fused user heading value
-
Remove listener from changes in fused user heading value
Declaration
Swift
func removeFusedUserHeadingChangeListener(listener: FusedUserHeadingChangeListener)Parameters
listenerA listener to changes in fused user heading value
-
Start Location Services call
Declaration
Swift
func startLocationServices(delegate: LocationServicesCallback)Parameters
delegateA listener to get notified when start location services is successful or failed
-
Function to check if location services are started
Declaration
Swift
func isLocationServicesActive() -> Bool -
Stop Location Services call
Declaration
Swift
func stopLocationServices(delegate: LocationServicesCallback)Parameters
delegateA listener to get notified when stop location services is successful or failed