Session
A caller-driven clock keeps networking and liveness outside synchronous document edits.
Type Parameters
Section titled “Type Parameters”E extends EditEnvelope
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Session<
E>(options):Session<E>
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Session<E>
Properties
Section titled “Properties”archives
Section titled “archives”
readonlyarchives:object[]
branch
Section titled “branch”
readonlybranch:Branch
history
Section titled “history”
readonlyhistory: readonlyConfirmation<E>[]
members
Section titled “members”
readonlymembers:Set<string>
pending
Section titled “pending”
readonlypending:Map<string,E>
Accessors
Section titled “Accessors”branch
Section titled “branch”Get Signature
Section titled “Get Signature”get branch():
Branch
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get host():
string|undefined
Returns
Section titled “Returns”string | undefined
isHost
Section titled “isHost”Get Signature
Section titled “Get Signature”get isHost():
boolean
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get peer():
string
Returns
Section titled “Returns”string
presenceTime
Section titled “presenceTime”Get Signature
Section titled “Get Signature”get presenceTime():
number
Returns
Section titled “Returns”number
status
Section titled “status”Get Signature
Section titled “Get Signature”get status():
"waiting"|"collecting"|"stable"|"handoff"|"left"|"activating"
Returns
Section titled “Returns”"waiting" | "collecting" | "stable" | "handoff" | "left" | "activating"
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(
peer):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
disconnect()
Section titled “disconnect()”disconnect(
peer):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
leave()
Section titled “leave()”leave(
successor?):void
Parameters
Section titled “Parameters”successor?
Section titled “successor?”string
Returns
Section titled “Returns”void
receive()
Section titled “receive()”receive(
message):boolean
Parameters
Section titled “Parameters”message
Section titled “message”Message<E>
Returns
Section titled “Returns”boolean
retire()
Section titled “retire()”retire(
peer):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
sendPresence()
Section titled “sendPresence()”sendPresence(
payload):void
Parameters
Section titled “Parameters”payload
Section titled “payload”Returns
Section titled “Returns”void
submit()
Section titled “submit()”submit(
edit):void
Parameters
Section titled “Parameters”E
Returns
Section titled “Returns”void
subscribePresence()
Section titled “subscribePresence()”subscribePresence(
observer): () =>void
Parameters
Section titled “Parameters”observer
Section titled “observer”Returns
Section titled “Returns”() => void
subscribePresenceClock()
Section titled “subscribePresenceClock()”subscribePresenceClock(
listener): () =>void
Parameters
Section titled “Parameters”listener
Section titled “listener”(now) => void
Returns
Section titled “Returns”() => void
tick()
Section titled “tick()”tick(
now):void
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void