.SUPERVISOR
Benachrichtigt den Supervisor und verwaltet Supervisor-Zusatzinformationen (RAGAI.SUPERVISOR).
setInfo/getInfo sind dünne Wrapper um RAGAI.KEYVAL mit fest verdrahtetem Typ "supervisor" -
es handelt sich also um denselben Speicher wie RAGAI.KEYVAL, nur unter einem eigenen Namespace, um
Kollisionen mit anderen KeyVal-Einträgen zu vermeiden. notify löst serverseitig eine
Supervisor-Hilfeanfrage für eine konkrete Verlaufsnachricht aus (sichtbar im Supervisor-/Admin-Bereich).
Methoden
.notify(messageName, historyItemId?)
Benachrichtigt den Supervisor, dass eine Nachricht Hilfe benötigt.
| Parameter | Typ | Beschreibung |
|---|---|---|
messageName | string | z.input<typeof supervisorNotifySchema> | Name/Typ der Benachrichtigung, oder ein Objekt gemäß supervisorNotifySchema. |
historyItemId | string | ID der betroffenen Verlaufsnachricht. |
Objekt-Form (validiert über supervisorNotifySchema):
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
messageName | string | ✔ | Name/Typ der Benachrichtigung. |
Rückgabewert: Promise<void>
Nichts.
.setInfo(key, value?)
Speichert eine Zusatzinformation für den Supervisor.
| Parameter | Typ | Beschreibung |
|---|---|---|
key | string | z.input<typeof supervisorKeyValueSchema> | Eindeutiger Schlüssel, oder ein Objekt gemäß supervisorKeyValueSchema. |
value | unknown | Der zu speichernde Wert. |
Objekt-Form (validiert über supervisorKeyValueSchema):
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
key | string | ✔ | Eindeutiger Schlüssel der Zusatzinformation. |
value | any | ✔ | Der zu speichernde Wert. |
Rückgabewert: Promise<KeyValEntry>
Der gespeicherte Eintrag.
.getInfo(key)
Liest eine zuvor gespeicherte Supervisor-Zusatzinformation.
| Parameter | Typ | Beschreibung |
|---|---|---|
key | string | z.input<typeof supervisorKeySchema> | Der gesuchte Schlüssel, oder ein Objekt gemäß supervisorKeySchema. |
Objekt-Form (validiert über supervisorKeySchema):
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
key | string | ✔ | Der gesuchte Schlüssel. |
Rückgabewert: Promise<{} | null>
Der gespeicherte Wert, oder null.