Interface: ActivityEngine
@roomful/core / ActivityEngine
Interface: ActivityEngine
Section titled “Interface: ActivityEngine”Defined in: packages/core/src/types.ts:1919
A shared, bounded, newest-first feed of room activity. Every record is broadcast to peers and
entries are ordered by timestamp, so all peers converge on the same recent feed. See
docs/reference/engines-activity.md.
Methods
Section titled “Methods”getEntries()
Section titled “getEntries()”getEntries():
ActivityEntry[]
Defined in: packages/core/src/types.ts:1934
Returns the current feed, newest first.
Returns
Section titled “Returns”The activity entries.
record()
Section titled “record()”record(
type,data?):ActivityEntry
Defined in: packages/core/src/types.ts:1927
Records an activity entry and broadcasts it to peers.
Parameters
Section titled “Parameters”string
The activity type label.
unknown
An optional structured payload.
Returns
Section titled “Returns”The recorded entry.
subscribe()
Section titled “subscribe()”subscribe(
callback):Unsubscribe
Defined in: packages/core/src/types.ts:1942
Subscribes to feed changes; fires immediately with the current feed, then on every change.
Parameters
Section titled “Parameters”callback
Section titled “callback”(entries) => void
The callback invoked with the latest entries.
Returns
Section titled “Returns”A function that removes the listener.