LINE Messaging API SDK for PHP

JoinEvent extends BaseEvent
in package

A class that represents the event of joining.

Table of Contents

$event  : array<string|int, mixed>
__construct()  : mixed
JoinEvent constructor.
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.
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()

JoinEvent constructor.

public __construct(array<string|int, mixed> $event) : mixed
Parameters
$event : array<string|int, mixed>
Return values
mixed —

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
throws
InvalidEventSourceException
Return values
null|string —

getGroupId()

Returns group ID of the event.

public getGroupId() : string|null
Tags
throws
InvalidEventSourceException

Raise when called with non group type event.

Return values
string|null —

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
throws
InvalidEventSourceException

Raise when called with non room type event.

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
Return values
bool —

Search results