Merge pull request #3 from tawk/TAWK-860rywc83-new-api-for-connections

Tawk-860rywc83-new-api-for-connections

Author: jao-tawk

addon/components/tawk-messenger.js

@@ -47,6 +47,7 @@ export default class TawkMessengerComponent extends Component {
 			widgetId : this.args.widgetId,
 			embedId : this.args.embedId,
 			basePath : this.args.basePath,
+			autoStart : this.args.autoStart
 		});
 
 		/**

addon/services/tawk-messenger.js

@@ -13,6 +13,14 @@ export default class TawkMessenger extends Service {
 	/**
 	 * API for calling an action on the widget
 	 */
+	start() {
+		return window.Tawk_API.start();
+	}
+
+	shutdown() {
+		return window.Tawk_API.shutdown();
+	}
+
 	maximize() {
 		return window.Tawk_API.maximize();
 	}

addon/utils/widget.js

@@ -1,4 +1,4 @@
-function loadScript({propertyId = '', widgetId = '', embedId = '', basePath = 'tawk.to'}) {
+function loadScript({propertyId = '', widgetId = '', embedId = '', basePath = 'tawk.to', autoStart = true}) {
 	if (embedId.length) {
 		/**
 		 * If the element with embedId as id we will create a new clement
@@ -13,6 +13,10 @@ function loadScript({propertyId = '', widgetId = '', embedId = '', basePath = 't
 		window.Tawk_API.embedded = embedId;
 	}
 
+	if (!autoStart) {
+		window.Tawk_API.autoStart = autoStart;
+	}
+
 	const script = document.createElement('script');
 	script.async = true;
 	script.src = `https://embed.${basePath}/${propertyId}/${widgetId}`;

docs/api-reference.md

@@ -31,6 +31,9 @@ Use the JavaScript API to manipulate the chat widget displayed on your website.
   - [onTagsUpdated](#ontagsupdated)
   - [onUnreadCountChanged](#onunreadcountchanged)
   - [visitor](#visitor)
+  - [autoStart](#autostart)
+  - [start](#start)
+  - [shutdown](#shutdown)
   - [maximize](#maximize)
   - [minimize](#minimize)
   - [toggle](#toggle)
@@ -458,6 +461,52 @@ this.tawkMessenger.visitor({
 
 <br/>
 
+## autoStart
+If set to true, it will auto-start the Tawk socket connection for chat services. If set to false,
+you will need to manually call the start API. It will not register and connect to the dashboard
+if this is set to false.
+
+```hbs
+<TawkMessenger
+    @propertyId={{'property_id'}}
+    @widgetId={{'widget_id'}}
+    @autoStart={{false}}/>
+```
+
+<br/>
+
+## start
+Start the tawk socket connection.
+
+```js
+this.tawkMessenger.start();
+
+// Example
+
+@action
+handleOnLoad() {
+  this.tawkMessenger.start();
+}
+```
+
+<br/>
+
+## shutdown
+End the tawk socket connection.
+
+```js
+this.tawkMessenger.shutdown();
+
+// Example
+
+@action
+handleOnLoad() {
+  this.tawkMessenger.shutdown();
+}
+```
+
+<br/>
+
 ## maximize
 Maximizes the chat widget.