@wxcc-desktop/sdk 1.3.0 → 1.3.2

package/README.md

@@ -377,6 +377,81 @@ Desktop.dialer.removeAllEventListeners();
 
 ```
 
+### `Desktop.monitoring` sub-module
+`Desktop.monitoring` sub-module is intended to make aqm requests and listen to notifs events related to call monitoring entity.
+```Javascript
+import { Desktop } from "@wxcc-desktop/sdk";
+
+//...
+
+/* 
+  Supposing Desktop.config.init() was called
+*/
+
+// Start the monitoring request to aqm:
+await Desktop.monitoring.startMonitoring({ ... });
+
+// End the monitoring request to aqm:
+await Desktop.monitoring.endMonitoring({ ... });
+
+// Pause the monitoring request to aqm:
+await Desktop.monitoring.holdMonitoring({ ... });
+
+// Resume the pause monitoring request to aqm:
+await Desktop.monitoring.unHoldMonitoring({ ... });
+
+// Module supports removing added listeners like:
+const listener = msg => console.log(msg);
+Desktop.monitoring.addEventListener("eMonitoringOffered", listener);
+Desktop.monitoring.addEventListener("eMonitoringStarted", listener);
+Desktop.monitoring.addEventListener("eMonitoringRequestCreateFailed", listener);
+Desktop.monitoring.addEventListener("eMonitoringFailed", listener);
+Desktop.monitoring.addEventListener("eMonitoringEnded", listener);
+Desktop.monitoring.addEventListener("eMonitoringEndFailed", listener);
+Desktop.monitoring.addEventListener("eMonitoringHeld", listener);
+Desktop.monitoring.addEventListener("eMonitoringHoldFailed", listener);
+Desktop.monitoring.addEventListener("eMonitoringUnHeld", listener);
+Desktop.monitoring.addEventListener("eMonitoringUnHoldFailed", listener);
+
+Desktop.monitoring.removeEventListener("eMonitoringOffered", listener);
+Desktop.monitoring.removeEventListener("eMonitoringStarted", listener);
+Desktop.monitoring.removeEventListener("eMonitoringRequestCreateFailed", listener);
+Desktop.monitoring.removeEventListener("eMonitoringFailed", listener);
+Desktop.monitoring.removeEventListener("eMonitoringEnded", listener);
+Desktop.monitoring.removeEventListener("eMonitoringEndFailed", listener);
+Desktop.monitoring.removeEventListener("eMonitoringHeld", listener);
+Desktop.monitoring.removeEventListener("eMonitoringHoldFailed", listener);
+Desktop.monitoring.removeEventListener("eMonitoringUnHeld", listener);
+Desktop.monitoring.removeEventListener("eMonitoringUnHoldFailed", listener);
+
+
+// Module supports one-time added listeners like:
+Desktop.monitoring.addOnceEventListener("eMonitoringOffered", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringStarted", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringRequestCreateFailed", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringFailed", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringEnded", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringEndFailed", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringHeld", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringHoldFailed", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringUnHeld", listener);
+Desktop.monitoring.addOnceEventListener("eMonitoringUnHoldFailed", listener);
+
+Desktop.monitoring.removeOnceEventListener("eMonitoringOffered", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringStarted", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringRequestCreateFailed", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringFailed", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringEnded", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringEndFailed", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringHeld", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringHoldFailed", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringUnHeld", listener);
+Desktop.monitoring.removeOnceEventListener("eMonitoringUnHoldFailed", listener);
+// Module supports removing all listeners like:
+Desktop.monitoring.removeAllEventListeners();
+
+```
+
 ### `Desktop.screenpop` sub-module
 `Desktop.screenpop` sub-module is intended to make aqm requests and listen to notifs events related to screenpop entity.
 ```Javascript