API Docs for: 2.0.20133.2
Show:

ui.chat.SDK Class

Defined in: src\internal\ui\chat\sdk.ts:9
Module: UI Chat
Parent Module: UI

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

Item Index

Methods

Methods

sendMessage

(
  • message
)
Promise

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

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

Parameters:

  • message String

    A message to insert in the chat

Returns:

Promise:

Example:

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

updateContext

(
  • properties
)
Promise

Defined in src\internal\ui\chat\sdk.ts:32

Update the current chat context

Parameters:

  • properties Object

    List of properties to update

Returns:

Promise:

Example:

ui.chat.render(config).then(
    function(sdk) {
        // Update the current chat context
        sdk.updateContext({ foo: "bar" });
    },
    function() {
        console.log("Unable to render chat");
    });