Class LiveLocation

A point on the map

Hierarchy (View Summary)

Constructors

constructor

Properties

geo live type

Accessors

heading inputMedia latitude longitude period radius

Methods

preview

Constructors

constructor

Properties

Readonlygeo

geo: RawGeoPoint

Readonlylive

live: RawMessageMediaGeoLive

Readonlytype

type: "live_location" = ...

Accessors

heading

  • get heading(): null | number

  • A direction in which the location moves, in degrees; 1-360

    Returns null | number

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

latitude

  • get latitude(): number

  • Geo point latitude

    Returns number

longitude

  • get longitude(): number

  • Geo point longitude

    Returns number

period

  • get period(): number

  • Validity period of provided geolocation

    Returns number

radius

  • get radius(): number

  • Accuracy radius in meters.

    Returns number

Methods

preview

  • preview(
        params?: {
            height?: number;
            scale?: number;
            width?: number;
            zoom?: number;
        },
    ): 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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods