Host
Type Parameters
Section titled “Type Parameters”Snapshot
Section titled “Snapshot”Snapshot = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Host<
Snapshot>(options):Host<Snapshot>
Parameters
Section titled “Parameters”options
Section titled “options”HostOptions<Snapshot>
Returns
Section titled “Returns”Host<Snapshot>
Accessors
Section titled “Accessors”hostSequence
Section titled “hostSequence”Get Signature
Section titled “Get Signature”get hostSequence():
number
Returns
Section titled “Returns”number
Methods
Section titled “Methods”outcome()
Section titled “outcome()”outcome(
id):HostMessage|undefined
Parameters
Section titled “Parameters”Returns
Section titled “Returns”HostMessage | undefined
submit()
Section titled “submit()”submit(
envelope,sender,rejection?):SubmitResult
The transport supplies sender from its authenticated session, never from the frame.
Parameters
Section titled “Parameters”envelope
Section titled “envelope”sender
Section titled “sender”string
rejection?
Section titled “rejection?”string
Returns
Section titled “Returns”subscribe()
Section titled “subscribe()”subscribe(
listener): () =>void
Parameters
Section titled “Parameters”listener
Section titled “listener”(message) => void
Returns
Section titled “Returns”() => void
text()
Section titled “text()”text():
string
Returns
Section titled “Returns”string