Conversation Toolkit API

lightning/conversationToolkitApi

Conversation Toolkit API is a collection of front-end API methods for interacting with the MIAW or Enhanced Messaging product using the lightning/conversationToolkitApi module. The lightning/conversationToolkitApi module requires API version 60.0 or later.

For Use In

Lightning Experience

All the methods in the lightning/conversationToolkitApi module return a promise. Required method parameters are explicitly passed as individual arguments. Optional parameters are passed into an object as the last argument of the method.

To use the Conversation Toolkit API in your component, import the functions in your component's JavaScript file.

Using Conversation Toolkit API in markup via the lightning-conversation-toolkit-api component is deprecated. Use the imported functions instead. Some functions are available only by import.

For this module's documentation, see LWC Methods for Enhanced Messaging in Lightning Experience in the Console Developer Guide.