telegramsjs
    Preparing search index...

    Class Location

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    heading?: number

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

    horizontalAccuracy?: number

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

    latitude: number

    Latitude as defined by sender

    livePeriod?: number

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

    longitude: number

    Longitude as defined by sender

    proximityAlertRadius?: number

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

    Accessors

    Methods

    • Protected

      Creates a clone of the current instance

      Returns Base

      A clone of the current instance

    • 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

      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

    • 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.

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

      Returns string | null