@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Interface RoboSetupUpdate

    A robo host's setup-progress update, pushed to the host owner's user socket each time the provisioning script reports a completed step.

    Advisory only — nothing in the SDK gates on these. Three things make them lossy, and none are fixable client-side:

    • the relay delivers only to a connected client, and never replays;
    • the host reports each step best-effort over plain HTTP, and carries on when a report fails;
    • re-running the setup script replays the whole sequence from 0.

    So an update can be missed or seen twice, and no sequence of them tells you a host is ready. Use RoboHost.waitUntilOnline for that. This is the canonical statement of the caveat; other doc comments point here.

    interface RoboSetupUpdate {
        description: string;
        final: boolean;
        organisationId: string;
        step: number;
    }
    Index

    Properties

    description: string

    A short, human-readable label for that step, supplied by the API — e.g. "Robo guardian image pulled". The API owns the wording and may change it, so never branch on it.

    final: boolean

    Whether the API considers this the last step of a successful setup.

    Means "the script's final report arrived", not "the robos are up": the container starts moments before this is sent, and its guardians have not reached the relay yet.

    organisationId: string

    The organisation whose host reported the step.

    step: number

    Which step the host reported, starting at 0.

    Good for ordering, de-duping a replay, or a "step N" label. Not for detecting the end: the API does not say how many steps there are, so there is nothing to compare against. Use final.