hello
- Kommando
hello- Bereich
- Grundlage
- Profil
- Pflicht
- Antwort
- Angaben zur Anzeige und ihre Fähigkeiten
hello ist die einzige Stelle, an der ein Steuerprogramm erfährt, womit es zu
tun hat. Es soll als erster Auftrag einer Verbindung gesendet werden, ist aber
keine Voraussetzung für die übrigen Kommandos: Wer nur schnell ein Ruhebild
setzen will, darf das ohne Vorrede tun.
Auftrag#
{"v":1,"cmd":"hello","client":{"name":"Bibliothekssoftware","version":"15.2","lang":"de"}}
| Feld | Pflicht | Inhalt |
|---|---|---|
client.name |
nein | Name des Steuerprogramms, für den Mitschnitt |
client.version |
nein | dessen Fassung |
client.lang |
nein | Sprache, in der das Steuerprogramm arbeitet |
auth.token |
nein | vereinbartes Geheimnis, siehe Betrieb |
Antwort#
{"v":1,"ok":true,"result":{
"server":"Anzeigeprogramm","version":"0.2.0","proto":[1],
"caps":["session","idle","message","venue","monitor","config","lifecycle"],
"lang":["de","en","uk"],
"limits":{"items":50,"line":8192}}}
| Feld | Pflicht | Inhalt |
|---|---|---|
server |
ja | Name der Anzeige |
version |
ja | deren Fassung |
proto |
ja | Liste der unterstützten Protokollfassungen, z. B. [1] |
caps |
ja | vorhandene Bereiche, siehe Kommandos |
lang |
nein | Sprachen, in denen die Anzeige formulieren kann |
limits.items |
nein | Höchstzahl der Einträge in items je Auftrag |
limits.line |
nein | größte verarbeitbare Zeilenlänge in Byte |
Was ein Steuerprogramm damit tut#
caps ist die Grundlage jeder Fallunterscheidung: Fehlt message, unterbleiben
Hinweise; fehlt session, kommt allenfalls ein Ruhebild in Frage. Ein
Steuerprogramm merkt sich die Antwort und fragt nicht vor jedem Auftrag erneut.
Wer nur wissen will, ob ein Bereich überhaupt vorhanden ist, findet dieselbe Angabe in der Kenndatei (siehe Betrieb) – ohne zu verbinden und selbst dann, wenn die Anzeige gerade nicht läuft.