-
Notifications
You must be signed in to change notification settings - Fork 0
/
share-whiteboard-companion.js
213 lines (190 loc) · 7.59 KB
/
share-whiteboard-companion.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/********************************************************
*
* Macro Author: Victor Vazquez
* Technical Solutions Architect
* vvazquez@cisco.com
* Cisco Systems
*
* Version: 1-0-0
* Released: 12/04/24
*
* This Webex Device macro allows users to share whiteboards
* via email simply by clicking on a button on the Navigator.
*
* This specific version of this macro has been designed for
* Companion mode use case. This macro should be installed and
* enabled on the main Room Device. The macro then lets a user
* share a Whiteboard which may be open on the Companion Board
* from the main Room Devices Navigator.
*
* Full Readme and source code and license details available here:
* https://github.com/wxsd-sales/share-whiteboard-macro
*
********************************************************/
import xapi from 'xapi';
/*********************************************************
* Configure the settings below
**********************************************************/
const emailConfig = {
destination: 'user@example.com', // Change this value to the email address you want the whiteboard to be sent to
body: 'Here you have your white board', // Email body text of your choice, this is an example
subject: 'New white board', // Email subject of your choice, this is an example
attachmentFilename: 'myfile-companion-mode.pdf' // File name of your choice, this is an example
};
const buttonConfig = {
name: 'Send whiteboard',
icon: 'Tv',
panelId: 'share-wb'
};
const remoteDeviceconfig = {
deviceIP: 'X.X.X.X', // Change this value to the Cisco Board IP adddress
userName: 'user', // Change this value to the Board user with Admin rights
password: 'password', // Board user with Admin rights password
};
const credentials = btoa(`${remoteDeviceconfig.userName}:${remoteDeviceconfig.password}`);
/*********************************************************
* Main functions and event subscriptions
**********************************************************/
// Set HTTP Client Config and listen for Panel Clicks
xapi.Config.HttpClient.Mode.set('On');
xapi.Config.HttpClient.AllowInsecureHTTPS.set('True');
xapi.Event.UserInterface.Extensions.Panel.Clicked.on(shareWhiteBoard);
// Create UI Extension Panel
createPanel();
/*********************************************************
* Instructs the Companion Device to send the Whitebard
* to configured email destination
**********************************************************/
function sendWhiteBoardUrl(url) {
const xml = ` <Command>
<Whiteboard>
<Email>
<Send>
<Subject>${emailConfig.subject}</Subject>
<Body>${emailConfig.body}</Body>
<Recipients>${emailConfig.destination}</Recipients>
<BoardUrls>${url}</BoardUrls>
<AttachmentFilenames>${emailConfig.attachmentFilename}.pdf</AttachmentFilenames>
</Send>
</Email>
</Whiteboard>
</Command>`;
xapi.Command.HttpClient.Post({
AllowInsecureHTTPS: 'True',
Header: ['Authorization: Basic ' + credentials],
Url: `https://${remoteDeviceconfig.deviceIP}/putxml`
}, xml)
.catch(error => console.log('Error sending whiteboard', error))
.then(reponse => {
console.log('putxml response status code:', reponse.StatusCode);
alert({ message: `Whiteboard has been sent to ${emailConfig.destination}` });
})
}
/*********************************************************
* Listen for Panel Click Events and check Whiteboard xStatus
* of Companion Device before attempting to send the Whiteboard
**********************************************************/
async function shareWhiteBoard(event) {
if (event.PanelId != buttonConfig.panelId) return;
console.log(`Button ${buttonConfig.panelId} clicked`);
console.log('Checking Companion Board WhiteBoard status')
alert({message: 'Checking for visible whiteboards on Companion Board', duration:5});
// Get Board URL from the WB
let boardUrl = '';
await xapi.Command.HttpClient.Get({
AllowInsecureHTTPS: 'True',
Header: ['Authorization: Basic ' + credentials],
Url: `https://${remoteDeviceconfig.deviceIP}/getxml?location=/Status/Conference/Presentation/WhiteBoard`
})
.then(response => {
boardUrl = response.Body.split("<BoardUrl>")[1].split("</BoardUrl>")[0];
console.log('Board Url read in WB', boardUrl);
if(!boardUrl){
alert({ title: 'Warning', message: 'You need to share a whiteboard before it can be sent' });
return
}
})
.catch(error => {
console.log('Error getting Board URL;', error);
console.log(boardUrl);
})
if (boardUrl == '') {
alert('You need to share a White Board before it can be sent');
return;
}
else {
console.log('Instructing Webex Board to send whiteboard:', boardUrl);
sendWhiteBoardUrl(boardUrl); // Instruct Board to send URL
}
}
/*
* Alert Function for Logging & Displaying Notification on Device
* @property {object} args - Alert details
* @property {string} args.message - Message Text
* @property {string} args.title - Alert Title
* @property {number} args.duration - Alert Duration
*/
function alert(args) {
if (!args.hasOwnProperty('message')) {
console.error('message is required to display alert')
return
}
let duration = 5;
if(args.hasOwnProperty('duration')){
duration = args.duration;
}
console.log('Displaying Alert:', args)
if (args.hasOwnProperty('title')) {
switch (args.title.toLowerCase()) {
case 'warning':
xapi.Command.UserInterface.Message.Alert.Display({ Duration: 10, Text: args.message, Title: args.title });
break;
default:
xapi.Command.UserInterface.Message.Prompt.Display({ Duration: duration, Text: args.message, Title: args.title });
}
} else {
xapi.Command.UserInterface.Message.Prompt.Display({ Duration: duration, Text: args.message, Title: 'Sharing Whiteboard Macro' })
}
}
/*********************************************************
* Create the UI Extension Panel and Save it to the Device
**********************************************************/
async function createPanel() {
const panelId = buttonConfig.panelId;
let order = "";
const orderNum = await panelOrder(panelId);
if (orderNum != -1) order = `<Order>${orderNum}</Order>`;
const panel = `
<Extensions>
<Panel>
${order}
<Origin>local</Origin>
<Location>CallControls</Location>
<Icon>${buttonConfig.icon}</Icon>
<Name>${buttonConfig.name}</Name>
<ActivityType>Custom</ActivityType>
</Panel>
</Extensions>`
xapi.Command.UserInterface.Extensions.Panel.Save(
{ PanelId: panelId },
panel
)
.catch(e => console.log('Error saving panel: ' + e.message))
}
/*********************************************************
* Gets the current Panel Order if exiting Macro panel is present
* to preserve the order in relation to other custom UI Extensions
**********************************************************/
async function panelOrder(panelId) {
const list = await xapi.Command.UserInterface.Extensions.List({
ActivityType: "Custom",
});
if (!list.hasOwnProperty("Extensions")) return -1;
if (!list.Extensions.hasOwnProperty("Panel")) return -1;
if (list.Extensions.Panel.length == 0) return -1;
for (let i = 0; i < list.Extensions.Panel.length; i++) {
if (list.Extensions.Panel[i].PanelId == panelId)
return list.Extensions.Panel[i].Order;
}
return -1;
}