Interface: DevtoolsBridge
@roomful/devtools / DevtoolsBridge
Interface: DevtoolsBridge
Section titled “Interface: DevtoolsBridge”Defined in: types.ts:314
Exposes the devtools bridge available to browser extensions and overlays.
Properties
Section titled “Properties”version
Section titled “version”version:
number
Defined in: types.ts:349
Stores the bridge protocol version.
Methods
Section titled “Methods”disconnectSimulatedPeer()
Section titled “disconnectSimulatedPeer()”disconnectSimulatedPeer(
instanceId):DevtoolsCommandResult
Defined in: types.ts:321
Disconnects an injected simulated peer.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
The room instance to target.
Returns
Section titled “Returns”The command result.
getSnapshot()
Section titled “getSnapshot()”getSnapshot(
instanceId):DevtoolsRoomSnapshot|null
Defined in: types.ts:329
Reads the latest room snapshot for an instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
The room instance to target.
Returns
Section titled “Returns”DevtoolsRoomSnapshot | null
The room snapshot, or null when unavailable.
injectSimulatedPeer()
Section titled “injectSimulatedPeer()”injectSimulatedPeer(
instanceId):DevtoolsCommandResult
Defined in: types.ts:337
Injects a simulated peer into a room instance.
Parameters
Section titled “Parameters”instanceId
Section titled “instanceId”string
The room instance to target.
Returns
Section titled “Returns”The command result.
listRooms()
Section titled “listRooms()”listRooms():
DevtoolsRoomSummary[]
Defined in: types.ts:344
Lists registered room summaries.
Returns
Section titled “Returns”The registered room summaries.