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

Cisco TelePresence SX20 Codec

Introduction

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
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
Title: String (0, 255)
Enter the message title.
Text: String (0, 255)
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.
FeedbackId: String (0, 255)
To identify the feedback enter a FeedbackId.
Option.1: String (0, 255)
Enter the text to appear on the feedback options.
Option.2: String (0, 255)
Enter the text to appear on the feedback options.
Option.3: String (0, 255)
Enter the text to appear on the feedback options.
Option.4: String (0, 255)
Enter the text to appear on the feedback options.
SX20 Codec API Reference Guide CE8.1, APRIL 2016.
D15316.03
About the API xConfiguration xCommand xCommand
Option.5: String (0, 255)
Enter the text to appear on the feedback options.

xCommand UserInterface Message Prompt Response

Give a response to the xCommand Message Prompt Display.
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
USAGE:
xCommand UserInterface Message Prompt Response [FeedbackId: "FeedbackId"]
OptionId: OptionId
where
FeedbackId: String (0, 255)
The FeedbackId corresponds to the FeedbackId given by the xCommand Message
Prompt Display command.
OptionId: Integer (1..5)
The OptionId corresponds to the OptionIds given as possible responses in the
xCommand Message Prompt Display command.

xCommand UserInterface Message TextLine Clear

Clears the text line which was defined by the xCommand Message TextLine Display command.
Requires user role: ADMIN, USER
USAGE:
xCommand UserInterface Message TextLine Clear
122
API Reference Guide
xStatus Appendices
Copyright © 2016 Cisco Systems, Inc. All rights reserved.