💬
Flutter Freshchat
A Flutter plugin for integrating Freshchat in your mobile app.
Setup
Android
Add this to your AndroidManifest.xml
<provider
android:name="android.support.v4.content.FileProvider"
android:authorities="com.example.demoapp.provider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data
android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/freshchat_file_provider_paths" />
</provider>
If you have migrated to AndroidX your might need change the provider attribute android:name to this:
<provider android:name="androidx.core.content.FileProvider">
</provider>
Add this to your Strings.xml located inside android/src/res/values
<string name="freshchat_file_provider_authority">com.example.demoapp.provider</string>
Firebase Cloud Messaging support
- Add dependency in
<app-name>/android/app/build.gradle
dependencies {
implementation "com.github.freshdesk:freshchat-android:3.3.0"
}
- Create
FreshchatMessagingService.java(Java, not Kotlin) class to your app in the same directory as yourMainActivityclass
package com.example.app;
import com.freshchat.consumer.sdk.Freshchat;
import com.google.firebase.messaging.RemoteMessage;
import io.flutter.plugins.firebasemessaging.FlutterFirebaseMessagingService;
public class FreshchatMessagingService extends FlutterFirebaseMessagingService {
@Override
public void onNewToken(String token) {
super.onNewToken(token);
}
@Override
public void onMessageReceived(final RemoteMessage remoteMessage) {
super.onMessageReceived(remoteMessage);
if (Freshchat.isFreshchatNotification(remoteMessage)) {
Freshchat.handleFcmMessage(this, remoteMessage);
}
}
}
- In
AndroidManifest.xmladd
<service android:name=".FreshchatMessagingService">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
- In your
Applicationclass change
FlutterFirebaseMessagingService.setPluginRegistrant(this)
to
FreshchatMessagingService.setPluginRegistrant(this)
IOS
- Add this to info.plist
Starting with iOS 10, Apple requires developers to declare access to privacy-sensitive controls ahead of time.
<key>NSPhotoLibraryUsageDescription</key>
<string>To Enable access to Photo Library</string>
<key>NSCameraUsageDescription</key>
<string>To take Images from Camera</string>
- If you encounter
non-modular headererror during project build
error: include of non-modular header inside framework module 'flutter_freshchat.FlutterFreshchatPlugin'
- Manually in xcode update the FreshchatSDK.h to be in the flutter_freshchat target and public.
Usage
To use this plugin, add flutter_freshchat as a dependency in your pubspec.yaml file.
import 'package:flutter_freshchat/flutter_freshchat.dart';
Initialize the Freshchat app with appID, appKey & domain which you could get from here: Where to find App ID and App Key
It has following [FreshchatConfig] properties:
-
domainEach Freshchat cluster falls in to one of this domains:- US - https://msdk.freshchat.com (default)
- AU - https://msdk.au.freshchat.com
- EU - https://msdk.eu.freshchat.com
- IN - https://msdk.in.freshchat.com
- US2 - https://msdk.us2.freshchat.com
-
cameraEnabledproperty is used to either enable or disable camera within freshchat conversation widget. It default value is set totrue. -
gallerySelectionEnabledproperty is used to either enable or disable gallery within freshchat conversation widget. It default value is set totrue. -
teamMemberInfoVisibleproperty is used to show team member info within freshchat conversation widget. It default value is set totrue. -
responseExpectationEnabledproperty is used to show exceptions that occur within freshchat conversation widget. It default value is set totrue. -
showNotificationBannerproperty is used enabled or disable in-app notification banner. It default value is set totrue. (NOTE: IOS only). -
notificationSoundEnabledproperty is used enabled or disable in-app notification sound. It default value is set totrue. (NOTE: IOS only).
await FlutterFreshchat.init(
appID: 'YOUR_APP_ID_HERE',
appKey: 'YOUR_APP_KEY_HERE',
domain: 'https://msdk.freshchat.com'
);
Update the user info by setting by creating a FreshchatUser object
FreshchatUser user = FreshchatUser.initial();
user.email = "[email protected]";
user.firstName = "john";
user.lastName = "doe";
user.phoneCountryCode = "+91";
user.phone = "0123456789";
await FlutterFreshchat.updateUserInfo(user: user);
// Custom properties can be set by creating a Map<String, String>
Map<String, String> customProperties = Map<String, String>();
customProperties["loggedIn"] = "true";
await FlutterFreshchat.updateUserInfo(user: user, customProperties: customProperties);
Identify the user user by usin email address or any way you uniquely identify the user. externalID is required and returns a restoreID you can save it and use to restore the chats
await FlutterFreshchat.identifyUser(externalID: 'USER_UNIQUE_ID', restoreID: 'USER_RESTORE_ID');
Show conversation opens a conversation screen and also list all the other conversation if a list obejct is supplied to it. You can also pass a title for the chat screen.
await FlutterFreshchat.showConversations(tags: const [], title: 'CHAT_SCREEN_TITLE');
Send message directly within the app without opening the Freshchat interface. tag is optional.
await FlutterFreshchat.send(message: 'YOUR_MESSAGE_HERE', tag: 'YOUR_TAG_HERE');
ShowFAQs opens a FAQ screen in a grid like format as default you can change the default setting by changing this paramters.
showFaqCategoriesAsGrid = true
showContactUsOnAppBar = true
showContactUsOnFaqScreens = false
showContactUsOnFaqNotHelpful = false
await FlutterFreshchat.showFAQs();
Gets the unseen message count from freshchat you can use this to show a counter.
int count = await FlutterFreshchat.getUnreadMsgCount();
Reset user data at logout or when deemed appropriate based on user action in the app.
await FlutterFreshchat.resetUser();
Example
Find the example wiring in the Flutter_Freshchat example application.
API details
See the flutter_freshchat.dart for more API details
Issues and feedback
Please file issues to send feedback or report a bug. Thank you!
![[BUG] Crash in iOS when calling FlutterFreshchat](https://avatars.githubusercontent.com/u/49975138?v=4)
![[BUG] The whole new version（v1.3.0） is wrong](https://avatars.githubusercontent.com/u/6271483?v=4)
https://imgur.com/a/BRYZt0R
This setup on the SDK is often lost by flutter when rebuilding the project, so you may have to reapply it. (I could not find a way to do it automatically)![[BUG] Can't build for iOS](https://avatars.githubusercontent.com/u/4974603?v=4)
![[BUG] Unsupported version of Picaso found](https://avatars.githubusercontent.com/u/7662987?v=4)
31 Oct 21, 2022
13 Oct 21, 2022
24 Dec 15, 2022
190 Dec 26, 2022
80 Oct 20, 2022
21 Dec 26, 2022
8 Sep 28, 2022
5 Nov 2, 2022
0 Dec 3, 2021
21 Dec 22, 2022
2 Mar 3, 2021
401 Jan 4, 2023
8 Oct 31, 2022
2 Sep 19, 2022
1 Feb 3, 2022
131 Jan 9, 2023
14 Dec 30, 2022
2 Oct 17, 2022
3 Aug 24, 2022