💬 livechat

codecov CI license pub package PRs Welcome GitHub contributors GitHub last commit

A livechat package for embedding mobile chat window in your mobile application.

🎖 Installing

dependencies:
  livechatt: "^1.4.0"

⚡️ Import

import 'package:livechatt/livechatt.dart';

🎮 How To Use

Get the Crendentials for your LiveChat

Android

  • Edit AndroidManifest.xml as shown below

Internet and Storage Access

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

ChatWindow

<activity android:name="com.livechatinc.inappchat.ChatWindowActivity" android:configChanges="orientation|screenSize" />

iOS - Manifest

  • Set minimum deployment target of iOS to 11.0
  • Edit info.plist as shown below

Sending Files From Device Library

<key>NSPhotoLibraryUsageDescription</key>
<string>This app requires access to the photo library.</string>
<key>NSMicrophoneUsageDescription</key>
<string>This app require access to the microphone.</string>
<key>NSCameraUsageDescription</key>
<string>This app requires access to the camera.</string>

Having issues running on ios?

Add the below to your podfile

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)
    target.build_configurations.each do |config|
      config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '11.0'
    end
  end
end

Dart Usage

  • Regular usage
onPressed: (){
    Livechat.beginChat(LICENSE_NO, GROUP_ID, VISITOR_NAME, VISITOR_EMAIL);
    },
  • Cases where there are custom parameters
var cmap = <String, String>{
    'org': 'organizationTextController.text',
    'position': 'positionTextController.text'
  };

onPressed: (){
    Livechat.beginChat(LICENSE_NO, GROUP_ID, VISITOR_NAME, VISITOR_EMAIL, cmap);
    },

For more info, please, refer to the main.dart in the example.

Views

🐛 Bugs/Requests

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on Github and I'll look into it. Pull request are also welcome.

❗️ Note

This project is a starting point for a Flutter plug-in package, a specialized package that includes platform-specific implementation code for Android and/or iOS.

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

🤓 Developer(s)

Abada Samuel Oghenero

⭐️ License

MIT LICENSE

Libraries

livechatt