openmixer — generated API reference
    Preparing search index...

    Interface AdapterStatusReport

    An AdapterConfig plus its live status, as returned by adapter.list.

    interface AdapterStatusReport {
        detail?: string;
        enabled: boolean;
        error?: string;
        id: string;
        present?: boolean;
        settings: Readonly<Record<string, unknown>>;
        status: AdapterStatus;
        type: string;
    }
    Index
    detail?: string

    A richer, type-specific status detail beyond the generic AdapterStatus — e.g. the reac type's honest link state (unconfigured / saved-nic-absent / probing / established, see reac-adapter.ts's ReacLinkStatus). Absent for types with nothing finer-grained to report than status; the web-ui falls back to the generic status dot whenever this is absent, so adding a detail to one type never changes how any other type renders.

    enabled: boolean
    error?: string

    Last error message when status === 'error'.

    id: string
    present?: boolean

    Whether the physical endpoint is currently detected (presence-probed types only — see AdapterTypeRegistration.probe). Absent for unprobeable types and before the first probe. Reported, not persisted.

    settings: Readonly<Record<string, unknown>>
    type: string