WemapMapSDK/com.getwemap.sdk.map.location/UserLocationState

UserLocationState

enum UserLocationState : Enum<UserLocationState>

Whether the user location the map is showing is still to be trusted.

Chrome of your own that repeats the user's position — a levels rail marking the floor they are on, a recentre button — should say what the map says. Read it from UserLocationManager.locationState and follow it with UserLocationManager.locationStates.

It is the state the SDK derives from the location reports, which is not always the one the puck is drawn from: this can read NORMAL while the puck is still grey — briefly while positions are arriving again after a stale period, and before the very first fix. Both are the puck being conservative; the SDK has no report saying the position went stale.

Entries

NORMAL

Fixes are arriving, and the last position is current.

STALE

No fix has arrived for MapViewConfig.staleStateTimeout, or the source reported that it lost tracking.

Properties

entries

val entries: EnumEntries<UserLocationState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

isNormal

val isNormal: Boolean

true when the position is current.

isStale

val isStale: Boolean

true when the position may no longer be where the user is.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): UserLocationState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<UserLocationState>

Returns an array containing the constants of this enum type, in the order they're declared.