android-sdk-core/com.mapsted.positioning/CoreApi/Location

Location

interface Location

Use LocationManager to get data based on user location

Types

NearbyPropertiesChangedListener

interface NearbyPropertiesChangedListener

Listener for changes in nearby properties

PositionAnimationListener

interface PositionAnimationListener : Consumer<Position>

Listener for position animation to show user position movement.

PositionChangeListener

interface PositionChangeListener : Consumer<Position>

Listener for position change.

PositionVisibilityListener

interface PositionVisibilityListener : Consumer<Boolean>

Listener to show/hide user position

Functions

addNearbyPropertyChangeListener

abstract fun addNearbyPropertyChangeListener(listener: CoreApi.Location.NearbyPropertiesChangedListener): Boolean

Add listener for changes in nearby properties

addPositionAnimationListener

abstract fun addPositionAnimationListener(listener: CoreApi.Location.PositionAnimationListener): Boolean

add listener to get position for animation purpose.

addPositionChangeListener

abstract fun addPositionChangeListener(listener: CoreApi.Location.PositionChangeListener): Boolean

Get updates when user position changes

addPositionVisibilityChange

abstract fun addPositionVisibilityChange(listener: CoreApi.Location.PositionVisibilityListener): Boolean

add listener to get update about whether position should be visible or not

enableSnapBlueDotToRoute

abstract fun enableSnapBlueDotToRoute(enable: Boolean)

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

getCurrentUserZone

@Nullable

abstract fun getCurrentUserZone(): Zone

Get a Zone where the user currently located.

getLastKnownPosition

@Nullable

abstract fun getLastKnownPosition(): Position

get last known user position which may be null.

getLastPositionVisibility

abstract fun getLastPositionVisibility(): Boolean

get last info about whether position should be visible or not.

getNearByEntities

abstract fun getNearByEntities(callback: Consumer<List<EntityZoneDistance>>)

Get list of nearby entities

getNearbyProperties

abstract fun getNearbyProperties(): Set<Integer>

Gets HashSet of nearby properties

getQuickRoughEstimate

abstract fun getQuickRoughEstimate(locationListener: FusedGpsLocationManager.Listener)

Get a quick fuzzy location.

hasInit

abstract fun hasInit(): Boolean

Check if current user position exists or not.

heading

abstract fun heading(): CoreApi.Heading

Get access to heading-related information and utilities

isSnapBlueDotToRouteEnabled

abstract fun isSnapBlueDotToRouteEnabled(): Boolean

isUserOnSelectedProperty

abstract fun isUserOnSelectedProperty(): Boolean

Checks if the user is currently located on the currently selected property.

removeNearbyPropertyChangeListener

abstract fun removeNearbyPropertyChangeListener(listener: CoreApi.Location.NearbyPropertiesChangedListener): Boolean

remove listener

removePositionAnimationListener

abstract fun removePositionAnimationListener(listener: CoreApi.Location.PositionAnimationListener): Boolean

remove listener

removePositionChangeListener

abstract fun removePositionChangeListener(listener: CoreApi.Location.PositionChangeListener): Boolean

remove listener

removePositionVisibilityChange

abstract fun removePositionVisibilityChange(listener: CoreApi.Location.PositionVisibilityListener): Boolean

remove listener