Presence
Uses the caller’s clock only while renewal, queued state or expiry needs work.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Presence(
peerSessionId,documentId,channel?):Presence
Parameters
Section titled “Parameters”peerSessionId
Section titled “peerSessionId”string
documentId
Section titled “documentId”string
channel?
Section titled “channel?”Returns
Section titled “Returns”Presence
Properties
Section titled “Properties”documentId
Section titled “documentId”
readonlydocumentId:string
peerSessionId
Section titled “peerSessionId”
readonlypeerSessionId:string
Accessors
Section titled “Accessors”states
Section titled “states”Get Signature
Section titled “Get Signature”get states(): readonly
PresenceState[]
Returns
Section titled “Returns”readonly PresenceState[]
Methods
Section titled “Methods”attach()
Section titled “attach()”attach(): () =>
void
Returns
Section titled “Returns”() => void
dispose()
Section titled “dispose()”dispose():
void
Returns
Section titled “Returns”void
leave()
Section titled “leave()”leave():
void
Returns
Section titled “Returns”void
receive()
Section titled “receive()”receive(
peer,input):boolean
Parameters
Section titled “Parameters”string
unknown
Returns
Section titled “Returns”boolean
setLocalState()
Section titled “setLocalState()”setLocalState(
state):void
Parameters
Section titled “Parameters”LocalPresence | null
Returns
Section titled “Returns”void
subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”() => void
tick()
Section titled “tick()”tick(
now):void
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void