LeadMagnet/leadchat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: Update documentation in sdk, channels (#1094)

Browse Source 
Fix channels/whatsapp-sms-twilio.md
This commit is contained in:
Bharat Patodi
2020-07-26 12:18:54 +05:30
committed by GitHub
parent 0f2d3418f9
commit 858b72a404
2 changed files with 34 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/channels/website-sdk.md
View File

@@ -1,36 +1,35 @@
---
path: "/docs/website-sdk"
title: "Sending Information into Chatwoot"
path: '/docs/website-sdk'
title: 'Sending Information into Chatwoot'
---
Additional information about a contact is always useful. The Chatwoot Website SDK ensures that you can send additional information that you have about the user.
Additional information about a contact is always useful, Chatwoot website SDK ensures that you can send the additional info you have about the user.
If you have installed our code on your website, the SDK would expose `window.$chatwoot` object.
If you have installed our code on your website, SDK would expose `window.$chatwoot` object.
Inorder to make sure that the SDK has been loaded completely, please make sure that you listen to `chatwoot:ready` event as follows
In order to make sure that the SDK has been loaded completely, please make sure that you listen to `chatwoot:ready` event as follows:
```js
window.addEventListener('chatwoot:ready', function() {
window.addEventListener('chatwoot:ready', function () {
// Use window.$chatwoot here
// ...
})
});
```
To hide the bubble, you can use the following setting. Please not if you use this, then you have to trigger the widget by yourself.
To hide the bubble, you can use the setting mentioned below. **Note**: If you use this, then you have to trigger the widget by yourself.
```js
window.chatwootSettings = {
hideMessageBubble: false,
position: 'left', // This can be left or right
locale: 'en', // Language to be set
}
};
```
### To trigger widget without displaying bubble
```js
window.$chatwoot.toggle()
window.$chatwoot.toggle();
```
### To set the user in the widget
@@ -40,33 +39,33 @@ window.$chatwoot.setUser('identifier_key', {
email: 'email@example.com',
name: 'name',
avatar_url: '',
})
});
```
`setUser` accepts an identifier which can be a `user_id` in your database or any unique parameter which represents a user. You can pass email, name, avatar_url as params, support for additional parameters are in progress.
`setUser` accepts an identifier which can be a `user_id` in your database or any unique parameter which represents a user. You can pass email, name, avatar_url as params. Support for additional parameters is in progress.
Make sure that you reset the session when the user logouts of your app.
Make sure that you reset the session when the user logs out of your app.
### To set language manually
```js
window.$chatwoot.setLocale('en')
window.$chatwoot.setLocale('en');
```
To set the language manually use the setLocale function.
To set the language manually, use the `setLocale` function.
### To set labels on the conversation
Please note that the labels will be set on a conversation, if the user has not started a conversation, then the following items will not have any effect.
Please note that the labels will be set on a conversation if the user has not started a conversation. In that case, the following items will not have any effect:
```js
window.$chatwoot.addLabel('support-ticket')
window.$chatwoot.addLabel('support-ticket');
window.$chatwoot.removeLabel('support-ticket')
window.$chatwoot.removeLabel('support-ticket');
```
### To refresh the session (use this while you logout user from your app)
### To refresh the session (use this while you logout the user from your app)
```js
window.$chatwoot.reset()
window.$chatwoot.reset();
```