Reference
Host API
The public integration surface exposed by actor-scoped host helpers.
exposeChatApi creates Convex functions that resolve the actor in your host application before calling the component.
Conversations and messages
listConversationsreturns conversation summaries for the actor.listMessagesreturns ordered message projections after membership checks.sendTextsends an idempotent text message.sendAttachmentsends a provider-neutral attachment descriptor.editOwnTextPartreplaces the actor's text part when its expected revision matches.deleteOwnMessagecreates a delete-for-everyone tombstone and returns attachment keys for host cleanup.setReactiontoggles an allowlisted reaction.markReadThroughadvances the actor's read watermark monotonically.
Presence
heartbeatOnline,disconnectOnline, andlistOnlinemaintain app-level availability scoped to chat participants.heartbeatPresence,disconnectPresence, andlistPresencemaintain conversation sessions used for typing.setTypingupdates the actor's conversation-scoped typing state.
Applications may omit the presence wrappers when presence is disabled by product policy.
See the generated TypeScript declarations and package README for the exact arguments available in the current alpha.