Flutter Chatbot SDK

Installation#

Pub.dev#

$ flutter pub add ymchat_flutter

or manually add dependency to the pubspec.yaml

dependencies:
ymchat_flutter: <version>

Usage#

Import the YMChat library in your dart file.

import 'package:ymchat_flutter/ymchat_flutter.dart';

Set botId#

This is the first and compulsary step.

YmChat.setBotId("x1234567890");

YM AuthenticationToken#

ymAuthenticationToken is used to associate an identity of the user with the chat bot.

Whenever chatbot is launched with ymAuthenticationToken it will load the previous chats associated with this user since inception.

YmChat.setAuthenticationToken("token");

Note: History will load only when Show history flag is enabled in the channel settings

Push Notifications#

ymchat_flutter supports firebase notifications. Pass your FCM token in setDeviceToken method.

YmChat.setDeviceToken("token");

Note: Firebase service account key is required to send notifications. You can share the service account key with us. More info here

Payload#

Additional information can be passed in the form of key value pair from app to bot using payload.

YmChat.setPayload({ name: "Integration", type: "Flutter" });

Payload can be used to pass information from host app to bot. The payload dictionary should be JSON compatible else an error will be thrown

For passing data from bot to app refer bot Bot Events

payload security

Payload is securely passed in HTTPS post request to protect the information passed in it

On-Prem Deployments#

ymchat_flutter supports bots with on-prem deployments. For the bot to work, pass the on-prem URL to setCustomURL() method.

YmChat.setCustomURL("https://your-on-prem-url.com");

V2 bot#

You can enable V2 bot by calling setVersion() method. Default value is 1

YmChat.setVersion(2);

Speech to Text#

Speech to text can be enabled and disabled by calling setEnableSpeech(). Default value is false

YmChat.setEnableSpeech(true);

iOS#

If you are supporting Speech recognition, add following snippet to Info.plist of the host app

<key>NSMicrophoneUsageDescription</key>
<string>Your microphone will be used to record your speech when you use the Voice feature.</string>
<key>NSSpeechRecognitionUsageDescription</key>
<string>Speech recognition will be used to determine which words you speak into this device&apos;s microphone.</string>

Info.plist is found at path

<YourProjectRootDir>/ios/Runner/info.plist

Present chatbot#

Chat bot can be presented by calling startChatbot(). This method will display full screen chat view

YmChat.startChatbot();

Bot Events#

Bot events are used to pass information from bot to app. For passing events from app to bot refer Payload

EventChannel _ymEventChannel = const EventChannel("YMChatEvent");
_ymEventChannel.receiveBroadcastStream().listen((event) {
Map ymEvent = event;
log("${ymEvent['code']} : ${ymEvent['data']}");
});

Bot close event#

Bot close event is separetly sent and it can be handled in following way.

EventChannel _ymCloseEventChannel = const EventChannel("YMBotCloseEvent");
_ymCloseEventChannel.receiveBroadcastStream().listen((event) {
bool ymCloseEvent = event;
log(event.toString());
});

Close bot#

Bot can be programmatically closed using closeBot() function

YmChat.closeBot();

Unlink Device Token#

If you want to stop receiving push notifications you can unlink the device token. Device token typically is unlinked when the user logs out of the app.

YmChat.unLinkDeviceToken(
botId,
apiKey,
deviceToken,
() {
log("Device token unlinked");
},
(failureMessage) {
log(failureMessage);
});

Demo App#

A demo app can be used as a reference to better understand how this SDK can be integrated in the app https://github.com/yellowmessenger/ymchat-flutter-demo