ConsoleClientDevices
Defined in: console-sdk/src/runtime/consoleClient.ts:85
The device-command + snapshot surface of ConsoleClient
(SDK_PLAN.md §3.6.10). list/get are point-in-time snapshot reads (never
a subscription); connect/disconnect/forget carry the rejecting
(*Async) semantics (§3.8.3); controls(id) returns the same rejecting
per-device controls core the hook wraps.
Methods
Section titled “Methods”connect()
Section titled “connect()”connect(
target,opts?):Promise<Device>
Defined in: console-sdk/src/runtime/consoleClient.ts:99
Connects a device and resolves the Device at ready — rejects
with a ConnectError on failure
(imperative callers want exceptions, §3.6.10 / §3.8.3).
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Promise<Device>
controls()
Section titled “controls()”controls(
id):ConsoleControls
Defined in: console-sdk/src/runtime/consoleClient.ts:105
The rejecting per-device console controls (§3.6.4).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”disconnect()
Section titled “disconnect()”disconnect(
id,opts?):Promise<void>
Defined in: console-sdk/src/runtime/consoleClient.ts:101
Deliberate disconnect; { autoReconnect: false } also persists the opt-out.
Parameters
Section titled “Parameters”autoReconnect?
Section titled “autoReconnect?”boolean
Returns
Section titled “Returns”Promise<void>
forget()
Section titled “forget()”forget(
id):Promise<void>
Defined in: console-sdk/src/runtime/consoleClient.ts:103
Removes persistence + auto-reconnect eligibility for a device.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
get(
id):Device|null
Defined in: console-sdk/src/runtime/consoleClient.ts:93
The device with this id right now, or null if the fleet has never seen it.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Device | null
list()
Section titled “list()”list(
query?): readonlyDevice[]
Defined in: console-sdk/src/runtime/consoleClient.ts:91
A point-in-time snapshot of the unified device list (SDK_PLAN.md §3.6.2)
filtered by query, in the deterministic fleet ordering. A plain read —
for reactive updates use useDevices (§3.6.10).
Parameters
Section titled “Parameters”query?
Section titled “query?”Returns
Section titled “Returns”readonly Device[]