Xcommand Userinterface Extensions List; Xcommand Userinterface Extensions Set; Xcommand Userinterface Extensions Widget Action; Xcommand Userinterface Extensions Widget Setvalue - Cisco MX700 Reference Manual

Cisco TelePresence MX700 and MX800

Introduction

xCommand UserInterface Extensions List

List all user interface extensions (widgets) that exist on the video system.
Requires user role: INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand UserInterface Extensions List

xCommand UserInterface Extensions Set

Set the configuration scheme you have chosen in the user interface extensions (widgets)
for your room system. Updates the UserInterface Extensions status tree. This is a multiline
command.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL
USAGE:
xCommand UserInterface Extensions Set ConfigId: "ConfigId"
where
ConfigId: String (0, 40)
The unique identifier for the configuration.

xCommand UserInterface Extensions Widget Action

Sets the action of the given widget. Updates the UserInterface Extensions status tree.
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER
USAGE:
xCommand UserInterface Extensions Widget Action [Type: "Type"] [Value: "Value"]
WidgetId: "WidgetId"
where
Type: String (0..255)
The type of widget that is set.
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.
D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.
About the API xConfiguration xCommand xCommand

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
157
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.