docs/dev.inmo.tgbotapi.types.location/LiveLocation

LiveLocation

@Serializable

data class LiveLocation(val longitude: Double, val latitude: Double, val horizontalAccuracy: Meters? = null, val livePeriod: Seconds = INDEFINITE_LIVE_PERIOD, val heading: Degrees? = null, val proximityAlertRadius: Meters? = null) : Location, Livable, ProximityAlertable, Headed(source)

Constructors

constructor(longitude: Double, latitude: Double, horizontalAccuracy: Meters? = null, livePeriod: Seconds = INDEFINITE_LIVE_PERIOD, heading: Degrees? = null, proximityAlertRadius: Meters? = null)

Types

object Companion

Properties

@SerialName(value = "heading")

open override val heading: Degrees?

horizontalAccuracy

@SerialName(value = "horizontal_accuracy")

open override val horizontalAccuracy: Meters?

@SerialName(value = "latitude")

open override val latitude: Double

@SerialName(value = "live_period")

open override val livePeriod: Seconds

Period in Seconds

@SerialName(value = "longitude")

open override val longitude: Double

proximityAlertRadius

@SerialName(value = "proximity_alert_radius")

open override val proximityAlertRadius: Meters?

Functions

inline fun Location.asLiveLocation(): LiveLocation?

asStaticLocation

inline fun Location.asStaticLocation(): StaticLocation?

inline fun <T> Location.ifLiveLocation(block: (LiveLocation) -> T): T?

ifStaticLocation

inline fun <T> Location.ifStaticLocation(block: (StaticLocation) -> T): T?

liveLocationOrNull

inline fun Location.liveLocationOrNull(): LiveLocation?

liveLocationOrThrow

inline fun Location.liveLocationOrThrow(): LiveLocation

requireLiveLocation

inline fun Location.requireLiveLocation(): LiveLocation

requireStaticLocation

inline fun Location.requireStaticLocation(): StaticLocation

staticLocationOrNull

inline fun Location.staticLocationOrNull(): StaticLocation?

staticLocationOrThrow

inline fun Location.staticLocationOrThrow(): StaticLocation

whenLiveLocation

inline fun <T> Location.whenLiveLocation(block: (LiveLocation) -> T): T?

whenStaticLocation

inline fun <T> Location.whenStaticLocation(block: (StaticLocation) -> T): T?