Class Location

Hierarchy (View Summary)

Constructors

constructor

Properties

heading? horizontalAccuracy? latitude livePeriod? longitude proximityAlertRadius?

Accessors

client

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

Properties

Optionalheading

heading?: number

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

OptionalhorizontalAccuracy

horizontalAccuracy?: number

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

latitude

latitude: number

Latitude as defined by sender

OptionallivePeriod

livePeriod?: number

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

longitude

longitude: number

Longitude as defined by sender

OptionalproximityAlertRadius

proximityAlertRadius?: number

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

Accessors

client

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data: Record<string, any>): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data: Record<string, any>): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

toJSON

  • toJSON(
        propsRecursive?: boolean,
        ...props: Record<string, string | boolean>[],
    ): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • ...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods