Xcommand Userinterface Message Alert Display; Xcommand Userinterface Message Prompt Clear; Xcommand Userinterface Message Prompt Display - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

xCommand UserInterface Message Alert Display

Display a message on screen, for a specified duration of time (in seconds).
NOTE: If Duration is not set, the command must be followed by xCommand Message Alert
Clear.
Use the xFeedback commands to monitor the feedback from the user. Read more about the
xFeedback commands in the API introduction section in this guide.
Requires user role: ADMIN, ROOMCONTROL
USAGE:
xCommand UserInterface Message Alert Display [Title: "Title"] Text: "Text"
[Duration: Duration]
where
: String (0, 255)
Title
Enter a message title.
: String (0, 255)
Text
Enter the message to be displayed. The <p> and <br> HTML tags will result in line
breaks as normal; any other tags will appear as plain text.
: Integer (0..3600)
Duration
Set how long (in seconds) the message is to be displayed on the screen. If set to
0 (zero) the message does not disappear until a xCommand Message Alert Clear
message has been sent.

xCommand UserInterface Message Prompt Clear

Remove the window displayed using the xCommand Message Alert Display command.
Use the xFeedback commands to monitor the feedback from the user. Read more about the
xFeedback commands in the API introduction section in this guide.
Requires user role: ADMIN, USER, ROOMCONTROL
USAGE:
xCommand UserInterface Message Prompt Clear [FeedbackId: "FeedbackId"]
where
: String (0, 255)
FeedbackId
The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API xConfiguration xCommand xCommand

xCommand UserInterface Message Prompt Display

Display a small window on screen with a title, text and up to five options for response from the
user. The message is displayed on screen until the user gives a response, or until the system
receives the following command xCommand Message Prompt Clear.
Use the xFeedback commands to monitor the feedback from the user. Read more about the
xFeedback commands in the API introduction section in this guide.
Title:
Text:
FeedbackId:
Option.1 to Option.5:
Requires user role: ADMIN, ROOMCONTROL
USAGE:
xCommand UserInterface Message Prompt Display [Title: "Title"] Text: "Text"
[FeedbackId: "FeedbackId"] [Option.1: "Option.1"] [Option.2: "Option.2"] [Option.3:
"Option.3"] [Option.4: "Option.4"] [Option.5: "Option.5"]
where
: String (0, 255)
Title
Enter the message title.
: String (0, 255)
Text
Enter the text line to be displayed. The <p> and <br> HTML tags will result in line breaks
as normal; any other tags will appear as plain text.
: String (0, 255)
FeedbackId
To identify the feedback enter a FeedbackId.
: String (0, 255)
Option.1
Enter the text to appear on the feedback options.
: String (0, 255)
Option.2
Enter the text to appear on the feedback options.
: String (0, 255)
Option.3
Enter the text to appear on the feedback options.
: String (0, 255)
Option.4
Enter the text to appear on the feedback options.
: String (0, 255)
Option.5
Enter the text to appear on the feedback options.
141
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.