Interface MessageLocation

A message with a location. Subtype of MessageContent.

interface MessageLocation {
    @type: "messageLocation";
    expires_in: number;
    heading: number;
    live_period: number;
    location: Location;
    proximity_alert_radius: number;
}

Properties

@type: "messageLocation"
expires_in: number

Left time for which the location can be updated, in seconds. If 0, then the location can't be updated anymore. The update updateMessageContent is not sent when this field changes.

heading: number

For live locations, a direction in which the location moves, in degrees; 1-360. If 0 the direction is unknown.

live_period: number

Time relative to the message send date, for which the location can be updated, in seconds; if 0x7FFFFFFF, then location can be updated forever.

location: Location

The location description.

proximity_alert_radius: number

For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Available only to the message sender.