Interface: TimelineEntry
@roomful/core / TimelineEntry
Interface: TimelineEntry
Section titled “Interface: TimelineEntry”Defined in: packages/core/src/types.ts:2179
A single entry in the shared collaborative history timeline. Every peer’s HistoryEngine.capture and HistoryEngine.transaction appends one of these to a timeline that converges across all peers, so the whole room sees the same ordered activity log.
Properties
Section titled “Properties”action
Section titled “action”action:
string
Defined in: packages/core/src/types.ts:2200
The action label supplied to capture/transaction (for example
'draw' or 'move-shape').
description
Section titled “description”description:
string
Defined in: packages/core/src/types.ts:2211
An optional human-readable description of the entry. Defaults to the
action when no explicit description is provided.
id:
string
Defined in: packages/core/src/types.ts:2183
Identifies the entry within the room.
peerId
Section titled “peerId”peerId:
string
Defined in: packages/core/src/types.ts:2188
The id of the peer that produced the entry.
peerName
Section titled “peerName”peerName:
string
Defined in: packages/core/src/types.ts:2194
The display name of the peer that produced the entry, resolved from presence at capture time. Falls back to the peer id when no name is set.
timestamp
Section titled “timestamp”timestamp:
number
Defined in: packages/core/src/types.ts:2205
The epoch-millisecond timestamp when the entry was captured.