BeaconDetectionEvent
extends BaseEvent
in package
A class that represents the event of beacon detection.
Table of Contents
- $event : array<string|int, mixed>
- __construct() : mixed
- BeaconDetectionEvent constructor.
- getBeaconEventType() : string
- Returns type of beacon event.
- getDeviceMessage() : string
- Returns device message of the beacon.
- getEvent() : array<string|int, mixed>
- Returns event
- getEventSourceId() : null|string
- Returns the identifier of the event source that associated with event source type (i.e. userId, groupId or roomId).
- getGroupId() : string|null
- Returns group ID of the event.
- getHwid() : string
- Get hardware ID of the beacon.
- getMode() : string
- Returns mode.
- getReplyToken() : string|null
- Returns reply token of the event.
- getRoomId() : string|null
- Returns room ID of the event.
- getTimestamp() : int
- Returns timestamp of the event.
- getType() : string
- Returns event type.
- getUserId() : string|null
- Returns user ID of the event.
- getWebhookEventId() : string
- Returns webhook event id
- isGroupEvent() : bool
- Returns the event is group's one or not.
- isRedelivery() : bool
- Returns the event is a redelivered one or not.
- isRoomEvent() : bool
- Returns the event is room's one or not.
- isUnknownEvent() : bool
- Returns the event is unknown or not.
- isUserEvent() : bool
- Returns the event is user's one or not.
Properties
$event
protected
array<string|int, mixed>
$event
Methods
__construct()
BeaconDetectionEvent constructor.
public
__construct(array<string|int, mixed> $event) : mixed
Parameters
- $event : array<string|int, mixed>
Return values
mixed —getBeaconEventType()
Returns type of beacon event.
public
getBeaconEventType() : string
Return values
string —getDeviceMessage()
Returns device message of the beacon.
public
getDeviceMessage() : string
Return values
string —a binary string containing data
getEvent()
Returns event
public
getEvent() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEventSourceId()
Returns the identifier of the event source that associated with event source type (i.e. userId, groupId or roomId).
public
getEventSourceId() : null|string
Tags
Return values
null|string —getGroupId()
Returns group ID of the event.
public
getGroupId() : string|null
Tags
Return values
string|null —getHwid()
Get hardware ID of the beacon.
public
getHwid() : string
Return values
string —getMode()
Returns mode.
public
getMode() : string
active: The channel is active. standby: The channel is waiting.
Return values
string —getReplyToken()
Returns reply token of the event.
public
getReplyToken() : string|null
Return values
string|null —getRoomId()
Returns room ID of the event.
public
getRoomId() : string|null
Tags
Return values
string|null —getTimestamp()
Returns timestamp of the event.
public
getTimestamp() : int
Return values
int —getType()
Returns event type.
public
getType() : string
Return values
string —getUserId()
Returns user ID of the event.
public
getUserId() : string|null
Return values
string|null —getWebhookEventId()
Returns webhook event id
public
getWebhookEventId() : string
Return values
string —isGroupEvent()
Returns the event is group's one or not.
public
isGroupEvent() : bool
Return values
bool —isRedelivery()
Returns the event is a redelivered one or not.
public
isRedelivery() : bool
Return values
bool —isRoomEvent()
Returns the event is room's one or not.
public
isRoomEvent() : bool
Return values
bool —isUnknownEvent()
Returns the event is unknown or not.
public
isUnknownEvent() : bool
Return values
bool —isUserEvent()
Returns the event is user's one or not.
public
isUserEvent() : bool