API Docs for: 2.0.20133.2
Show:

ui.virtualAgent.SDK Class

Defined in: src\internal\ui\virtualAgent\sdk.ts:9
Module: UI VirtualAgent
Parent Module: UI

An object resolved by the render() method to interact with the virtual agent component

Methods

endChat

()

Defined in src\internal\ui\virtualAgent\sdk.ts:50

Ends Chat with live agent in Virtual Agent

Example:

ui.virtualAgent.render(config).then(
    function(sdk) {
        // End the chat
        sdk.endChat();
    },
    function() {
        console.log("Unable to render virtual agent");
    });

sendMessage

(
  • message
)
Promise

Defined in src\internal\ui\virtualAgent\sdk.ts:14

Insert a message in the user's chat with virtual agent

Parameters:

  • message String

    A message to send to virtual agent

Returns:

Promise:

Example:

ui.virtualAgent.render(config).then(
    function(sdk) {
        // Send a message to virtual agent
        sdk.sendMessage("Test message");
    },
    function() {
        console.log("Unable to render virtual agent");
    });

showFeedback

()

Defined in src\internal\ui\virtualAgent\sdk.ts:67

shows feedback in Virtual Agent

Example:

ui.virtualAgent.render(config).then(
    function(sdk) {
        // show virtual agent feedback
        sdk.showFeedback();
    },
    function() {
        console.log("Unable to render virtual agent");
    });

startOver

()

Defined in src\internal\ui\virtualAgent\sdk.ts:33

Resets Virtual Agent

Example:

ui.virtualAgent.render(config).then(
    function(sdk) {
        // Reset virtual agent and start over
        sdk.startOver();
    },
    function() {
        console.log("Unable to render virtual agent");
    });