mirrorfly_chat

Description:

mirrorfly chat

MirrorFly Chat for Flutter #


Table of contents #

Introduction
Requirements
Sending your first message
Getting help

Introduction #
Make an easy and efficient way with CONTUS TECH MirrorFly Chat for Flutter - simply integrate the real-time chat features and functionalities into a client's app.
Requirements #
The minimum requirements for MirrorFly Chat for Flutter are:

Visual Studio Code or Android Studio
Dart 2.19.1 or above
Flutter 2.0.0 or higher

Step 1: Let's integrate MirrorFly Chat for Flutter #
Our MirrorFly Chat will let you initialize and configure the chat easily. With the server-side, Our solution ensures the most reliable infra-management services for the chat within the app. Furthermore, we will let you know how to install the chat plugin in your app for a better in-app chat experience.
MirrorFly License Key #
Follow the below steps to get your license key:

Sign up into MirrorFly Console page for free MirrorFly account, If you already have a MirrorFly account, sign into your account
Once you’re in! You get access to your MirrorFly account ‘Overview page’ where you can find a license key for further integration process
Copy the license key from the ‘Application info’ section

Step 2: Install packages #
Installing the MirrorFly Chat is a simple process. Follow the steps mentioned below.
Android #

Add the following to your root build.gradle file in your Android folder.

allprojects {
repositories {
google()
mavenCentral()
jcenter()
maven {
url "https://repo.mirrorfly.com/snapshot/"
}
}
}
copied to clipboard
iOS #

Check and Add the following code at end of your ios/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'] = '12.1'
config.build_settings['ENABLE_BITCODE'] = 'NO'
config.build_settings['APPLICATION_EXTENSION_API_ONLY'] = 'No'
config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
config.build_settings["EXCLUDED_ARCHS[sdk=iphonesimulator*]"] = "arm64"
end
end
end
copied to clipboard

Now, enable the below mentioned capabilities into your project by opening ios folder using Xcode.

Goto Project -> Target -> Signing & Capabilities -> Click `+ Capability` at the top left corner -> Search for `App groups` and add the `App group capability`
copied to clipboard

Note: The App Group Must be same as iOSContainerId given during the SDK Initialization. See Initialization Step 1.


Flutter #

Add following dependency in pubspec.yaml.

dependencies:
mirrorfly_chat: ^0.0.1
copied to clipboard

Run flutter pub get command in your project directory.

Step 3: Use the MirrorFly Chat in your App #
You can use all classes and methods just with the one import statement as shown below.
import 'package:mirrorfly_chat/mirrorfly.dart';
copied to clipboard
Sending your first message #
Follow the step-by-step instructions below to authenticate and send your first message.
Authentication #
In order to use the features of MirrorFly Chat, you should initiate the Mirrorfly instance through user authentication with MirrorFly server. This instance communicates and interacts with the server based on an authenticated user account, allowing the client app to use the MirrorFly Chat features.
Here are the steps to sending your first message using the MirrorFly Chat:
Step 1: Initialize the MirrorFly Chat #
To initialize the Chat, place the below code in your main.dart file inside main function before runApp().
void main() {
WidgetsFlutterBinding.ensureInitialized();
Mirrorfly.init(
baseUrl: 'https://api-preprod-sandbox.mirrorfly.com/api/v1/',
licenseKey: 'your license key',
iOSContainerID: 'your app group id');
runApp(const MyApp());
}
copied to clipboard
Step 2: Registration #
Use the below method to register a user in sandbox Live mode.

Info Unless you log out the session, make a note that should never call the registration method more than once in an application


Note: While registration, the below registerUser method will accept the FCM_TOKEN as an optional param and pass it across. The connection will be established automatically upon completion of registration and not required for seperate login.

Mirrorfly.registerUser(userIdentifier).then((value) {
// you will get the user registration response
var userData = registerModelFromJson(value);
}).catchError((error) {
// Register user failed print throwable to find the exception details.
debugPrint(error.message);
});
copied to clipboard
Send a One-to-One Message #
Use the below method to send a text message to other user,

Note: To generate a unique user jid by username, you must call the below method

var userJid = await Mirrorfly.getJid(username);
copied to clipboard
Mirrorfly.sendTextMessage(message, jid).then((value) {
// you will get the message sent success response
var chatMessage = sendMessageModelFromJson(value);
});
copied to clipboard
Receive a One-to-One Message #
Here the listeners would be called only when a new message is received from other user. To get more details please visit this callback listeners
Mirrorfly.onMessageReceived.listen(result){
// you will get the new messages
var chatMessage = sendMessageModelFromJson(result)
}
copied to clipboard
Try the sample app #
The fastest way to test MirrorFly Chat is to build your chat app on top of our sample app. To create a project for the sample app, download the app from our GitHub repository. The link is down below.

https://github.com/MirrorFly/MirrorFly-Flutter-Sample

Getting Help #
Check out the Official MirrorFly Flutter docs