GramIO API Reference / @gramio/contexts/dist / ProximityAlertTriggered
Class: ProximityAlertTriggered
Defined in: contexts/index.d.ts:2823
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
Constructors
Constructor
new ProximityAlertTriggered(
payload):ProximityAlertTriggered
Defined in: contexts/index.d.ts:2825
Parameters
| Parameter | Type |
|---|---|
payload | TelegramProximityAlertTriggered |
Returns
ProximityAlertTriggered
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramProximityAlertTriggered | contexts/index.d.ts:2824 |
Accessors
distance
Get Signature
get distance():
number
Defined in: contexts/index.d.ts:2831
The distance between the users
Returns
number
traveler
Get Signature
get traveler():
User
Defined in: contexts/index.d.ts:2827
User that triggered the alert
Returns
watcher
Get Signature
get watcher():
User
Defined in: contexts/index.d.ts:2829
User that set the alert