@wxcc-desktop/sdk 2.0.5 → 2.0.6

package/README.md

@@ -14,6 +14,7 @@ WxCC Agent Desktop JS API modules set
 - AQM/Notifs **agent-state** service layer API module for WxCC Agent Desktop.
 - AQM/Notifs **dialer** service layer API module for WxCC Agent Desktop.
 - AQM/Notifs **screenpop** service layer API module for WxCC Agent Desktop.
+- AQM/Notifs **aiAssistant** service layer API module for WxCC Agent Desktop.
 
 ### `Desktop` module
 
@@ -595,6 +596,36 @@ Desktop.webexMetricsInternal.trackBehavioralEvent(name: string, options?: EventP
 
 ```
 
+### `Desktop.aiAssistant` sub-module
+`Desktop.aiAssistant` sub-module is intended to listen to notifs events related to AI Assistant features
+
+```Javascript
+import { Desktop } from "@wxcc-desktop/sdk";
+
+//...
+
+/*
+  Supposing Desktop.config.init() was called
+*/
+
+// List of available AI Assistant aqm notifs events:
+Desktop.aiAssistant.addEventListener("eSuggestedResponseAvailable", msg => console.log(msg));
+Desktop.aiAssistant.addEventListener("eWellnessBreakEvent", msg => console.log(msg));
+
+// Module supports removing added listeners like:
+const listener = msg => console.log(msg);
+Desktop.aiAssistant.removeEventListener("eSuggestedResponseAvailable", listener);
+Desktop.aiAssistant.removeEventListener("eWellnessBreakEvent", listener);
+
+// Module supports one-time added listeners like:
+Desktop.aiAssistant.addOnceEventListener("eSuggestedResponseAvailable", listener);
+Desktop.aiAssistant.removeOnceEventListener("eSuggestedResponseAvailable", listener);
+
+// Module supports removing all listeners like:
+Desktop.aiAssistant.removeAllEventListeners();
+
+```
+
 ## Publish `@wxcc-desktop/sdk` to External npm Repository (e.g., npmjs.com)
 
 To publish the `@wxcc-desktop/sdk` package to an external npm repository like npmjs.com, follow these steps: