Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Class ChatMessageEvent

Emitted when another user sends a message to a particular Chat.

Hierarchy

Implements

Index

Properties

Properties

chatId

chatId: string

The ID of the Chat on which this event occurred

eventNumber

eventNumber: number

This event's unique sequential number. This can be useful when e.g. querying for events on a particular chat (Chat.getHistory).

message

message: string

The text of the message

name

name: string = ChatMessageEvent.NAME

The name of the event that was fired. This is commonly used to filter when using the ConvergenceEventEmitter.events stream.

Note that the name is only guaranteed to be unique within the class / subsystem that is firing it. Names might be reused across classes and subsystems.

timestamp

timestamp: Date

The timestamp when the event occurred

user

user: DomainUser

The user associated wth the event

NAME

NAME: "message" = "message"