Interface: UseActivityResult
@roomful/react / UseActivityResult
Interface: UseActivityResult
Section titled “Interface: UseActivityResult”Defined in: react/src/index.ts:363
Describes the return value of useActivity.
Properties
Section titled “Properties”entries
Section titled “entries”entries:
ActivityEntry[]
Defined in: react/src/index.ts:367
The activity feed, newest first. Reactive: re-renders on any local or remote entry.
record()
Section titled “record()”record: (
type,data?) =>ActivityEntry
Defined in: react/src/index.ts:372
Records an activity entry and broadcasts it to peers.
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”ActivityEntry
The recorded entry.