Location

data class Location(longitude: Float, latitude: Float, horizontalAccuracy: Float?, livePeriod: Int?, heading: Int?, proximityAlertRadius: Int?)

This object represents a point on the map.

Parameters

longitude

Longitude as defined by sender

latitude

Latitude as defined by sender

horizontalAccuracy

Optional. The radius of uncertainty for the location, measured in meters; 0-1500

livePeriod

Optional. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only.

heading

Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.

proximityAlertRadius

Optional. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.

Constructors

Location

common

fun Location(longitude: Float, latitude: Float, horizontalAccuracy: Float? = null, livePeriod: Int? = null, heading: Int? = null, proximityAlertRadius: Int? = null)

Longitude as defined by sender

Functions

component1

common

operator fun component1(): Float

component2

common

operator fun component2(): Float

component3

common

operator fun component3(): Float?

component4

common

operator fun component4(): Int?

component5

common

operator fun component5(): Int?

component6

common

operator fun component6(): Int?

copy

common

fun copy(longitude: Float, latitude: Float, horizontalAccuracy: Float? = null, livePeriod: Int? = null, heading: Int? = null, proximityAlertRadius: Int? = null): Location

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

heading

common

val heading: Int? = null

Optional.

horizontalAccuracy

common

val horizontalAccuracy: Float? = null

Optional.

latitude

common

val latitude: Float

Latitude as defined by sender

livePeriod

common

val livePeriod: Int? = null

Optional.

longitude

common

val longitude: Float

Longitude as defined by sender

proximityAlertRadius

common

val proximityAlertRadius: Int? = null

Optional.