GramIO API Reference / @gramio/contexts/dist / LocationAttachment
Class: LocationAttachment
Defined in: contexts/index.d.ts:461
This object represents a point on the map.
Extends
Constructors
Constructor
new LocationAttachment(
payload):LocationAttachment
Defined in: contexts/index.d.ts:433
Parameters
| Parameter | Type |
|---|---|
payload | TelegramLocation |
Returns
LocationAttachment
Inherited from
Properties
| Property | Type | Inherited from | Defined in |
|---|---|---|---|
attachmentType | AttachmentType | Attachment.attachmentType | contexts/index.d.ts:462 |
payload | TelegramLocation | Location.payload | contexts/index.d.ts:432 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:435
Returns
string
Inherited from
heading
Get Signature
get heading():
number
Defined in: contexts/index.d.ts:452
The direction in which user is moving, in degrees; 1-360. For active live locations only.
Returns
number
Inherited from
horizontalAccuracy
Get Signature
get horizontalAccuracy():
number
Defined in: contexts/index.d.ts:441
The radius of uncertainty for the location, measured in meters; 0-1500
Returns
number
Inherited from
latitude
Get Signature
get latitude():
number
Defined in: contexts/index.d.ts:439
Latitude as defined by sender
Returns
number
Inherited from
livePeriod
Get Signature
get livePeriod():
number
Defined in: contexts/index.d.ts:447
Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only.
Returns
number
Inherited from
longitude
Get Signature
get longitude():
number
Defined in: contexts/index.d.ts:437
Longitude as defined by sender
Returns
number
Inherited from
proximityAlertRadius
Get Signature
get proximityAlertRadius():
number
Defined in: contexts/index.d.ts:457
Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
Returns
number