Skip to content
SBC-Standard The data standard for libraries

message.show and message.clear

Commands
message.show, message.clear
Area
display (message)
Profile
notice display
Response
ok

A notice is independent of any session: "One moment please", "Till closed", "Today we close at 4 pm". It allows a screen that is not a patron display at all to be driven – in the entrance, in the window, at the return unit.

message.show#

{"v":1,"cmd":"message.show","severity":"warn","seconds":20,
 "title":"One moment please","text":"The connection is being checked.",
 "sticky":false}
Field Required Content
title yes heading of the notice
text no explanatory sentence
severity no info (default), warn or error
seconds no dwell time; without it the display decides
sticky no true: stays until it is removed

This is one of the few places where ready-made text is transmitted – the wording of a free notice cannot be derived from data. severity therefore governs only the presentation, never the wording.

A sticky notice gives way to a session that begins and returns afterwards. A notice with a dwell time disappears by itself once it has elapsed.

message.clear#

{"v":1,"cmd":"message.clear"}

Removes a sticky notice. If there is none, that is not an error: the display answers ok.

This page was translated automatically from the German original. If anything reads oddly or looks wrong, please let us know — the German edition prevails.