13.2.12. display_message

A module that implements this interface should be able to: - store (add, remove, change) and retrieve predefined messages - show messages on a display

When a display message contains a session id, the display message must be removed once the session has ended.

13.2.12.1. Commands

set_display_message:object

Command to set or replace a display message.

request:array <required>

Request to set a display message

array_item:object (display_message-DisplayMessage)

The display messages to set

There is an extended definition for this object here.

Result:object (display_message-SetDisplayMessageResponse)

Response to the set display message request.

There is an extended definition for this object here.

get_display_messages:object

Command to get one or more display messages.

request:object <required> (display_message-GetDisplayMessageRequest)

The request for display messages

There is an extended definition for this object here.

Result:object (display_message-GetDisplayMessageResponse)

The display messages or an empty array if there are none

There is an extended definition for this object here.

clear_display_message:object

Command to remove a display message

request:object <required> (display_message-ClearDisplayMessageRequest)

The request to clear a message

There is an extended definition for this object here.

Result:object (display_message-ClearDisplayMessageResponse)

Response on the clear message request

There is an extended definition for this object here.