@line/bot-sdk • Docs

---

@line/bot-sdk / BeaconEvent

Type Alias: BeaconEvent

BeaconEvent: ReplyableEvent & object

Event object for when a user enters or leaves the range of a LINE Beacon.

Type declaration

beacon

beacon: object

beacon.dm?

optional dm: string

Device message of beacon that was detected.

This message consists of data generated by the beacon to send notifications to bots. Only included in webhooks from devices that support the "device message" property. For more information, see the LINE Simple Beacon specification.

beacon.hwid

hwid: string

Hardware ID of the beacon that was detected

beacon.type

type: "enter" | "leave" | "banner" | "stay"

leave will be deprecated

type

type: "beacon"

Defined in

lib/types.ts:233