EventTimelineSetHandlerMap

EventTimelineSetHandlerMap = object

Defined in: src/models/event-timeline-set.ts:83

Properties

Room.timeline

Room.timeline: (event, room, toStartOfTimeline, removed, data) => void

Defined in: src/models/event-timeline-set.ts:104

Fires whenever the timeline in a room is updated.

Parameters

event

DigitalWorldEvent

The event which caused this event to fire.

room

Room | undefined

The room, if any, whose timeline was updated.

toStartOfTimeline

boolean | undefined

True if this event was added to the start

removed

boolean

True if this event has just been removed from the timeline (beginning; oldest) of the timeline e.g. due to pagination.

data

IRoomTimelineData

more data about the event

Returns

void

Example

digitalWorldClient.on("Room.timeline",
                function(event, room, toStartOfTimeline, removed, data) {
  if (!toStartOfTimeline && data.liveEvent) {
    var messageToAppend = room.timeline.[room.timeline.length - 1];
  }
});

---

Room.timelineReset

Room.timelineReset: (room, timelineSet, resetAllTimelines) => void

Defined in: src/models/event-timeline-set.ts:123

Fires whenever the live timeline in a room is reset.

When we get a ‘limited’ sync (for example, after a network outage), we reset the live timeline to be empty before adding the recent events to the new timeline. This event is fired after the timeline is reset, and before the new events are added.

Parameters

room

Room | undefined

The room whose live timeline was reset, if any

timelineSet

EventTimelineSet

timelineSet room whose live timeline was reset

resetAllTimelines

boolean

True if all timelines were reset.

Returns

void