Where is the documentation on the sn_cs.MultiPartOutMsg() API and sn_cs.SinglePartOutMsg() API used within Virtual Agent script?

vicnor
Kilo Contributor

We are using the Virtual Agent Designer to customize a chatbot. We are using the "Script Output" node, but we can't find the API documentation for this (in bold):

/*************************************************************** 
YOU CAN OUTPUT A SinglePartOutMsg (see full API for sn_cs.SinglePartOutMsg), 
LIKE THIS:

var singleOutMsg = new sn_cs.SinglePartOutMsg();
singleOutMsg.setTextPart('text part');
return singleOutMsg;
****************************************************************/ 

/*************************************************************** 
OR YOU CAN OUTPUT A MultiPartOutMsg (see full API for sn_cs.MultiPartOutMsg),
LIKE THIS:

var multiOutMsg = new sn_cs.MultiPartOutMsg();
multiOutMsg.setNavigationLabel('Click for More');
multiOutMsg.addPlainTextPart('text part 1');
multiOutMsg.addPlainTextPart('text part 2');
return multiOutMsg;

/*************************************************************** 

Can someone please show where that API documentation is located? Right now we are guessing the methods on the objects.

 

Thanks!

1 REPLY 1

The SN Nerd
Giga Sage
Giga Sage

I don't think it has been documented by ServiceNow at this time.

The only reference to that code I could find was in the Product Documentation:

https://docs.servicenow.com/bundle/newyork-performance-analytics-and-reporting/page/administer/virtu...

The API is currently not documented in the Developer API.

I'd suggest raising a HI Support call to request the documentation.


ServiceNow Nerd
ServiceNow Developer MVP 2020-2022
ServiceNow Community MVP 2019-2022