Skip to main content

.SUPERVISOR

Benachrichtigt den Supervisor und verwaltet Supervisor-Zusatzinformationen (RAGAI.SUPERVISOR).

Hintergrund

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.

ParameterTypBeschreibung
messageNamestring | z.input<typeof supervisorNotifySchema>Name/Typ der Benachrichtigung, oder ein Objekt gemäß supervisorNotifySchema.
historyItemIdstringID der betroffenen Verlaufsnachricht.

Objekt-Form (validiert über supervisorNotifySchema):

FeldTypPflichtBeschreibung
messageNamestringName/Typ der Benachrichtigung.

Rückgabewert: Promise<void>

Nichts.

.setInfo(key, value?)

Speichert eine Zusatzinformation für den Supervisor.

ParameterTypBeschreibung
keystring | z.input<typeof supervisorKeyValueSchema>Eindeutiger Schlüssel, oder ein Objekt gemäß supervisorKeyValueSchema.
valueunknownDer zu speichernde Wert.

Objekt-Form (validiert über supervisorKeyValueSchema):

FeldTypPflichtBeschreibung
keystringEindeutiger Schlüssel der Zusatzinformation.
valueanyDer zu speichernde Wert.

Rückgabewert: Promise<KeyValEntry>

Der gespeicherte Eintrag.

.getInfo(key)

Liest eine zuvor gespeicherte Supervisor-Zusatzinformation.

ParameterTypBeschreibung
keystring | z.input<typeof supervisorKeySchema>Der gesuchte Schlüssel, oder ein Objekt gemäß supervisorKeySchema.

Objekt-Form (validiert über supervisorKeySchema):

FeldTypPflichtBeschreibung
keystringDer gesuchte Schlüssel.

Rückgabewert: Promise<&#123;&#125; | null>

Der gespeicherte Wert, oder null.