Expand description
state.* method types — endpoint health snapshot + push notifications.
Drives the Client App’s “Health” tab (SPEC §2.1 use case 2):
BitLocker / AV signature / OS-patch / cert-expiry / disk-free /
agent-self-update + arbitrary additional compliance checks. The
snapshot is computed agent-side on demand (state.snapshot) and
pushed when underlying checks flip via state.changed.
Structs§
- Check
- One compliance check result.
nameis the stable id (used as React key + analytics label);statusdrives the row’s color;detailis human-readable text for the row body.troubleshootis the optionalManifest.idof the job whose execute button fixes this check —Nonemeans the check has no auto-remediation. - State
Changed Params - Push payload for
state.changed. Pushed by the agent when one or more compliance checks flip status, or whenonline/vpn/agent_versionchange. A fullStateSnapshotis included so the client doesn’t need a second round-trip — the push is strictly idempotent: applying astate.changedpayload onto the client’s cached snapshot is a no-op replace, not a diff merge. - State
Snapshot - Full state bundle — the SPA renders this verbatim on the Health tab. SPEC §2.12.8’s complete-conversation example pins the shape:
- State
Snapshot Params state.snapshottakes no params.- State
Subscribe Params state.subscribetakes no params.- State
Subscribe Result state.subscribereturns an opaque subscription handle. The client passes it back tostate.unsubscribeto stop the push stream; SPEC §2.12.7 says subscriptions are auto-cleaned on disconnect, so a well-behaved client never needs to remember these across reconnects.- State
Unsubscribe Params state.unsubscribeparams.
Enums§
- Check
Status - Four-state result mirroring the SPA’s color palette: ok = green,
warn = yellow, fail = red, unknown = grey. Wire-encoded as
snake_case (
"ok"/"warn"/"fail"/"unknown") — the PascalCase convention is reserved forsuper::error::ErrorKindwhere SPEC §2.12.9 specifically pins it.