Participant
Type Parameters
Section titled “Type Parameters”Snapshot
Section titled “Snapshot”Snapshot = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Participant<
Snapshot>(options):Participant<Snapshot>
Parameters
Section titled “Parameters”options
Section titled “options”ParticipantOptions<Snapshot>
Returns
Section titled “Returns”Participant<Snapshot>
Properties
Section titled “Properties”
readonlyactor:string
undoManager
Section titled “undoManager”
readonlyundoManager:UndoManager
Methods
Section titled “Methods”install()
Section titled “install()”install(
base,messages,recovered?,allocated?):void
Installs a verified branch while retaining authored pending work and local undo.
Parameters
Section titled “Parameters”Snapshot
messages
Section titled “messages”readonly HostMessage[]
recovered?
Section titled “recovered?”readonly Envelope[]
allocated?
Section titled “allocated?”readonly Envelope[]
Returns
Section titled “Returns”void
local()
Section titled “local()”local(
edit,capture?):Envelope
Parameters
Section titled “Parameters”capture?
Section titled “capture?”Returns
Section titled “Returns”localBatch()
Section titled “localBatch()”localBatch(
edits,capture?): readonlyEnvelope[]
Author the entire offset batch before recording history or publishing it.
Parameters
Section titled “Parameters”readonly OffsetEdit[]
capture?
Section titled “capture?”Returns
Section titled “Returns”readonly Envelope[]
receive()
Section titled “receive()”receive(
messages,allocated?):void
Parameters
Section titled “Parameters”messages
Section titled “messages”readonly HostMessage[]
allocated?
Section titled “allocated?”readonly Envelope[]
Returns
Section titled “Returns”void
setEffects()
Section titled “setEffects()”setEffects(
effects):Envelope
Parameters
Section titled “Parameters”effects
Section titled “effects”readonly Effect[]
Returns
Section titled “Returns”state()
Section titled “state()”state():
ParticipantState
Returns
Section titled “Returns”subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Parameters
Section titled “Parameters”listener
Section titled “listener”(change) => void
Returns
Section titled “Returns”() => void
text()
Section titled “text()”text():
string
Returns
Section titled “Returns”string