Class History

Hierarchy

EventEmitter<HistoryEvents, HistoryListeners>
- History

Index

Properties

Accessors

Events

Methods

Properties

messages

messages: MessageType[] = []

List of all messages sorted from oldest to most recent.

Readonly room_id

room_id: string

Room's id.

Accessors

Events

get Events(): typeof HistoryEvents

Returns typeof HistoryEvents

Methods

hasOlder

hasOlder(): boolean

Indicates if there are any older messages to load.

Returns boolean

hasUnread

hasUnread(id: string): boolean

Indicates if participant has any unread messages.

Parameters
- id: string
  
  Participant's id
Returns boolean

haveUnread

haveUnread(): boolean

Indicates if current user has any unread messages.

Returns boolean

isRead

isRead(timestamp: string): boolean

Indicates if message with the specified timestamp was read by anyone except current user.

Parameters
- timestamp: string
  
  Message's timestamp
Returns boolean

isReadBy

isReadBy(timestamp: string, userId: string): boolean

Indicates if participant has read the message with the specified timestamp.

Parameters
- timestamp: string
  
  Message's timestamp
- userId: string
  
  Participant's id
Returns boolean

isReadByMe

isReadByMe(timestamp: string): boolean

Indicates if current user has read the message with the specified timestamp.

Parameters
- timestamp: string
  
  Message's timestamp
Returns boolean

lastRead

lastRead(id: string): string

Get participant's last read message's timestamp.

Parameters
- id: string
  
  Participant's id
Returns string

lastReadByMe

lastReadByMe(): string

Get current user's last read message's timestamp.

Returns string

loadOlder

loadOlder(timestamp?: string): Promise<History>

Used for loading older chat room's history. Consecutive calls will be handled in a queue. Triggers HistoryEvents.OLD_LOADED on success.

throws
ChatError

Parameters
- Optional timestamp: string
  
  Timestamp to load messages before, by default oldest message's timestamp is used
Returns Promise<History>

loadUnread

loadUnread(): Promise<History>

Used for loading chat room's history up to the oldest unread message. Uses History.loadOlder method to load messages, thus triggering HistoryEvents.OLD_LOADED after each loaded batch of messages. Triggers HistoryEvents.UNREAD_LOADED on success.

throws
ChatError

Returns Promise<History>

markAsRead

markAsRead(timestamp: string): Promise<History>
markAsRead(timestamps: string[]): Promise<History>

Used for updating last read status. Consecutive calls will be grouped in a batch. Triggers HistoryEvents.READ_STATUS_UPDATED on success.

throws
ChatError

Parameters
- timestamp: string
  
  Message's id
Returns Promise<History>
Used for updating last read status. Consecutive calls will be grouped in a batch. Triggers HistoryEvents.READ_STATUS_UPDATED on success.

throws
ChatError

Parameters
- timestamps: string[]
  
  Messages' timestamps
Returns Promise<History>

off

off(): void
off<E>(event: E): void
off<E>(events: E[]): void
off<E>(event: E, listener: EventListener<HistoryListeners[E]>): void
off<E>(events: E[], listener: EventListener<HistoryListeners[E]>): void

Inherited from EventEmitter.off

Removes all listeners.

Returns void
Inherited from EventEmitter.off

Removes all listeners for event.

Type parameters
- E: HistoryEvents
Parameters
- event: E
Returns void
Inherited from EventEmitter.off

Removes all listeners for events.

Type parameters
- E: HistoryEvents
Parameters
- events: E[]
Returns void
Inherited from EventEmitter.off

Removes specific listener for event.

Type parameters
- E: HistoryEvents
Parameters
- event: E
- listener: EventListener<HistoryListeners[E]>
Returns void
Inherited from EventEmitter.off

Removes specific listener for multiple events.

Type parameters
- E: HistoryEvents
Parameters
- events: E[]
- listener: EventListener<HistoryListeners[E]>
Returns void

on

on<E>(event: E, listener: EventListener<HistoryListeners[E]>): void
on<E>(events: E[], listener: EventListener<HistoryListeners[E]>): void

Inherited from EventEmitter.on

Adds listener for event.

Type parameters
- E: HistoryEvents
Parameters
- event: E
- listener: EventListener<HistoryListeners[E]>
Returns void
Inherited from EventEmitter.on

Adds the same listener for multiple events.

Type parameters
- E: HistoryEvents
Parameters
- events: E[]
- listener: EventListener<HistoryListeners[E]>
Returns void

publish

publish(content: string): Promise<MessageType>

Used for sending a message to the chat room. Triggers HistoryEvents.MESSAGE on success.

throws
ChatError

Parameters
- content: string
  
  Message content
Returns Promise<MessageType>

readBy

readBy(timestamp: string): string[]

Returns list of users' ids (except current user) who read the message with the specified timestamp.

Parameters
- timestamp: string
  
  Message's timestamp
Returns string[]

unreadLoaded

unreadLoaded(): boolean

Indicates if all unread messages are loaded.

Returns boolean