Class LiveLocation

A point on the map

Hierarchy (view full)

RawLocation
- LiveLocation

Index

Constructors

Properties

Accessors

heading inputMedia latitude longitude period radius

Methods

Constructors

constructor

new LiveLocation(live): LiveLocation
Parameters
- live: RawMessageMediaGeoLive
Returns LiveLocation
Overrides RawLocation.constructor
- Defined in packages/core/src/highlevel/types/media/location.ts:109

Properties

`Readonly`geo

geo: RawGeoPoint

`Readonly`live

live: RawMessageMediaGeoLive

`Readonly`type

type: "live_location" = ...

Accessors

heading

get heading(): null | number
A direction in which the location moves, in degrees; 1-360

Returns null | number
- Defined in packages/core/src/highlevel/types/media/location.ts:116

inputMedia

get inputMedia(): TypeInputMedia
Input media TL object generated from this object, to be used inside InputMediaLike and TelegramClient.sendMedia

Note that using this will result in an independent live geolocation, which will not be auto-updated with the current

Returns TypeInputMedia
Overrides RawLocation.inputMedia
- Defined in packages/core/src/highlevel/types/media/location.ts:136

latitude

get latitude(): number
Geo point latitude

Returns number
Inherited from RawLocation.latitude
- Defined in packages/core/src/highlevel/types/media/location.ts:15

longitude

get longitude(): number
Geo point longitude

Returns number
Inherited from RawLocation.longitude
- Defined in packages/core/src/highlevel/types/media/location.ts:22

period

get period(): number
Validity period of provided geolocation

Returns number
- Defined in packages/core/src/highlevel/types/media/location.ts:123

radius

get radius(): number
Accuracy radius in meters.

Returns number
Inherited from RawLocation.radius
- Defined in packages/core/src/highlevel/types/media/location.ts:29

Methods

preview

preview(params?): FileLocation
Create FileLocation containing server-generated image with the map preview
Parameters
- params: {
      height?: number;
      scale?: number;
      width?: number;
      zoom?: number;
  } = {}
  - Optionalheight?: number
    Map height in pixels before applying scale (16-1024)
    
    Default
    128
  - Optionalscale?: number
    Map scale (1-3)
    
    Default
    1
  - Optionalwidth?: number
    Map width in pixels before applying scale (16-1024)
    
    Default
    128
  - Optionalzoom?: number
    Map zoom level (13-20)
    
    Default
    15
Returns FileLocation
Inherited from RawLocation.preview
- Defined in packages/core/src/highlevel/types/media/location.ts:37