Blip SDK for Web
SDK to easily add BLiP conversations in your Web page. For more information see BLiP portal and BLiP documentation.
Installation
Add the script element on your web page. Put your apikey as asked. To get your apikey please enter in contact with BLiP team
That's all :)
<script src="https://unpkg.com/blip-sdk-web" type="text/javascript"></script>
<script>
(function () {
new BlipWebSDK.ChatBuilder()
.withApiKey('PUT-YOUR-API-KEY-HERE')
.build();
})();
</script>
Via npm
If you are using ES6, simply install the blip-sdk-web
package from the npm registry.
npm install blip-sdk-web
###Instantiate the BlipSdkWeb class
import * as BlipWebSDK from 'blip-sdk-web';
new BlipWebSDK.ChatBuilder()
.withApiKey('PUT-YOUR-API-KEY-HERE')
.build();
Via bower
bower install blip-sdk-web
<script src="your-project/bower_components/blip-sdk-web/dist/blipWebSdk.js" type="text/javascript"></script>
<script>
(function () {
new BlipWebSDK.ChatBuilder()
.withApiKey('PUT-YOUR-API-KEY-HERE')
.build();
})();
</script>
Optional parameters
You can also define an optional parameters passing an object inside build() method, as you can see below:
Option | Description |
---|
title | Title of chat window |
onEnter | Callback action on enter chat |
onLeave | Callback action on leave chat |
###Example
var options = {
title: 'Send a message',
onEnter: function() {
console.log("I'm in the chat!");
},
onLeave: function() {
console.log("I'm out the chat!");
}
};
new BlipWebSDK.ChatBuilder()
.withApiKey('PUT-YOUR-API-KEY-HERE')
.build(options);
License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.