Cisco TelePresence DX70, Reference Manual

Page: 129 / 202

D15363.05 Cisco TelePresence DX70 and DX80 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. 129
Cisco TelePresence DX70 and DX80 API Reference Guide
xCommand UserInterface Extensions Widget SetValue
Set the value of the given widget. Updates the UserInterface Extensions status tree. Returns an
error if the value is out of range.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Extensions Widget SetValue Value: "
Value
" WidgetId:
"
WidgetId
"
where
Value
: String (0, 255)
The value of the widget. The range of values depends on the widget type.
WidgetId
: String (0, 40)
The unique identifier for the widget.
xCommand UserInterface Extensions Widget UnsetValue
Empties the value of the given widget. Updates the UserInterface Extensions status tree and
notifies the user interface that this widget is no longer selected.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Extensions Widget UnsetValue WidgetId: " WidgetId "
where
WidgetId
: String (0, 40)
The unique identifier for the widget.
xCommand UserInterface Message Alert Clear
Remove the message which was displayed using the xCommand Message Alert Display
command. This is required when the Duration parameter is not set.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand UserInterface Message Alert Clear
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, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Message Alert Display [Title: " Title "] Text: " Text "
[Duration: Duration ]
where
Title
: String (0, 255)
Enter a message title.
Text
: String (0, 255)
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.
Duration
: Integer (0..3600)
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. The default value is set to 0.
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, INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand UserInterface Message Prompt Clear [FeedbackId: "
FeedbackId
"]
where
FeedbackId
: String (0, 255)
The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
Introduction About the API xConfiguration Appendices xCommand xStatus

xCommand