Menu

## JoinEvent extends BaseEvent
in package

JoinEvent.php : 26

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

BaseEvent.php : 34
`protected array<string|int, mixed> $event`

### Methods

#### __construct()

JoinEvent.php : 33

JoinEvent constructor.

`public __construct(array<string|int, mixed> $event) : mixed`

##### Parameters

$event : array<string|int, mixed>

##### Return values

mixed —

#### getEvent()

BaseEvent.php : 223

Returns event

`public getEvent() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getEventSourceId()

BaseEvent.php : 200

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()

BaseEvent.php : 167

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()

BaseEvent.php : 64

Returns mode.

`public getMode() : string`

active: The channel is active. standby: The channel is waiting.

##### Return values

string —

#### getReplyToken()

BaseEvent.php : 104

Returns reply token of the event.

`public getReplyToken() : string|null`

##### Return values

string|null —

#### getRoomId()

BaseEvent.php : 183

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()

BaseEvent.php : 74

Returns timestamp of the event.

`public getTimestamp() : int`

##### Return values

int —

#### getType()

BaseEvent.php : 51

Returns event type.

`public getType() : string`

##### Return values

string —

#### getUserId()

BaseEvent.php : 154

Returns user ID of the event.

`public getUserId() : string|null`

##### Return values

string|null —

#### getWebhookEventId()

BaseEvent.php : 84

Returns webhook event id

`public getWebhookEventId() : string`

##### Return values

string —

#### isGroupEvent()

BaseEvent.php : 124

Returns the event is group's one or not.

`public isGroupEvent() : bool`

##### Return values

bool —

#### isRedelivery()

BaseEvent.php : 94

Returns the event is a redelivered one or not.

`public isRedelivery() : bool`

##### Return values

bool —

#### isRoomEvent()

BaseEvent.php : 134

Returns the event is room's one or not.

`public isRoomEvent() : bool`

##### Return values

bool —

#### isUnknownEvent()

BaseEvent.php : 144

Returns the event is unknown or not.

`public isUnknownEvent() : bool`

##### Return values

bool —

#### isUserEvent()

BaseEvent.php : 114

Returns the event is user's one or not.

`public isUserEvent() : bool`

##### Return values

bool —

## Search results