Interface: TimelineEntry
@roomful/solid / TimelineEntry
Interface: TimelineEntry
Section titled “Interface: TimelineEntry”Defined in: core/dist/types.d.ts:1878
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: core/dist/types.d.ts:1896
The action label supplied to capture/transaction (for example
'draw' or 'move-shape').
description
Section titled “description”description:
string
Defined in: core/dist/types.d.ts:1905
An optional human-readable description of the entry. Defaults to the
action when no explicit description is provided.
id:
string
Defined in: core/dist/types.d.ts:1882
Identifies the entry within the room.
peerId
Section titled “peerId”peerId:
string
Defined in: core/dist/types.d.ts:1886
The id of the peer that produced the entry.
peerName
Section titled “peerName”peerName:
string
Defined in: core/dist/types.d.ts:1891
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: core/dist/types.d.ts:1900
The epoch-millisecond timestamp when the entry was captured.