ConversationEvent

class ConversationEvent extends AbstractMessage

An event that happened in a conversation

Methods

Event
getEvent()

Get the event object

int
getCategory()

Get the type of the event

bool
isMessage()

Find out whether the event is a message and not a generic conversation event (such as a rename or member join)

static ConversationEvent
storeEvent(int $conversation, Event $event, string $type, mixed $timestamp = 'now', string $status = 'visible')

Store a conversation event in the database

static 
getQueryBuilder()

Get a query builder for events

Details

at line line 42
Event getEvent()

Get the event object

Return Value

Event

at line line 55
int getCategory()

Get the type of the event

Do not use ConversationEvent::getType(), as it returns the name of the class (i.e. conversationEvent)

Return Value

int

at line line 63
bool isMessage()

Find out whether the event is a message and not a generic conversation event (such as a rename or member join)

Return Value

bool

at line line 78
static ConversationEvent storeEvent(int $conversation, Event $event, string $type, mixed $timestamp = 'now', string $status = 'visible')

Store a conversation event in the database

Parameters

int $conversation The ID of the conversation
Event $event The event
string $type The type of the event
mixed $timestamp The timestamp when the event took place
string $status The status of the event, can be 'visible', 'hidden', 'deleted' or 'reported'

Return Value

ConversationEvent

at line line 93
static getQueryBuilder()

Get a query builder for events