mirrorfly_plugin

Description:

mirrorfly plugin

Mirrofly Plugin for Flutter #


Table of contents #

Introduction
Requirements
Sending your first message
Call_Feature
Getting help

Introduction #
Make an easy and efficient way with CONTUS TECH Mirrorfly Plugin for Flutter - simply integrate the real-time chat features and functionalities into a client's app.
Requirements #
The minimum requirements for Mirrorfly Plugin 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 Plugin for Flutter #
Our Mirrorfly Plugin lets 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.
Plugin 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 Plugin 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/release"
}
}
}
copied to clipboard
iOS #

Check and Add the following code at end of your ios/Podfile

post_install do |installer|
installer.aggregate_targets.each do |target|
target.xcconfigs.each do |variant, xcconfig|
xcconfig_path = target.client_root + target.xcconfig_relative_path(variant)
IO.write(xcconfig_path, IO.read(xcconfig_path).gsub("DT_TOOLCHAIN_DIR", "TOOLCHAIN_DIR"))
end
end

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'

shell_script_path = "Pods/Target Support Files/#{target.name}/#{target.name}-frameworks.sh"
if File::exist?(shell_script_path)
shell_script_input_lines = File.readlines(shell_script_path)
shell_script_output_lines = shell_script_input_lines.map { |line| line.sub("source=\"$(readlink \"${source}\")\"", "source=\"$(readlink -f \"${source}\")\"") }
File.open(shell_script_path, 'w') do |f|
shell_script_output_lines.each do |line|
f.write line
end
end
end
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_plugin: ^1.0.6
copied to clipboard

Run flutter pub get command in your project directory.

Step 3: Use the Mirrorfly Plugin in your App #
You can use all classes and methods just with the one import statement as shown below.
import 'package:mirrorfly_plugin/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 Plugin for Flutter, you should initiate the MirrorflyPlugin 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 Plugin's features.
Here are the steps to sending your first message using the Mirrorfly Plugin:
Step 1: Initialize the Mirrorfly Plugin #
To initialize the plugin, place the below code in your main.dart file inside main function before runApp().
void main() {
WidgetsFlutterBinding.ensureInitialized();
Mirrorfly.initializeSDK(
licenseKey: 'your license key',
iOSContainerID: 'your app group id',
chatHistoryEnable: false, // true to enable chat history, default is false
enablePrivateStorage: false, // true to enable private storage, default is false
flyCallback: (FlyResponse response) {
if (response.isSuccess) {
LogMessage.d("onSuccess", response.message);
} else {
LogMessage.d("onFailure", response.exception?.message.toString());
}
runApp(const MyApp());
});
}
copied to clipboard
Step 2: Login #
Use the below method to login a user in sandbox Live mode.

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


Note: While logging in, the login method will accept the FCM_TOKEN as an optional parameter and pass it across. The connection will be established automatically upon completion of the login process. If the user is new, the login method will also register the user.

Mirrorfly.login(userIdentifier,flyCallback: (FlyResponse response) {
// you will get the user registration response
if (response.isSuccess && response.hasData) {
var userData = registerModelFromJson(response.data); //message

} else {
// Register user failed print throwable to find the exception details.
if (response.exception?.code == "403") {
//admin blocked the user
} else if (response.exception?.code == "405") {
//maximum device limit reached
}
}
});
copied to clipboard

Note: After registering, make sure to update the profile of the registered user Update Profile.


Note: You need to re-login when the onLoggedOutevent is triggered.


Note: It is recommended to disallow users to backup an app if it contains sensitive data. Having access to backup files (i.e. when android:allowBackup="true"), it is possible to modify/read the content of an app even on a non-rooted device.


Caution: If FORCE_REGISTER is false and it reached the maximum no of multi-sessions then registration will not succeed it will throw a 405 exception, Either FORCE_REGISTER should be true or one of the existing session need to be logged out to continue registration.

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

To get JID of User #
var userJid = await Mirrorfly.getJid(username: username);
copied to clipboard
To get Group JID #
var groupJid = await Mirrorfly.getGroupJid(groupId: groupID);
copied to clipboard
Mirrorfly.sendMessage(messageParams: MessageParams.Text(toJid: "",
replyMessageId: "",textMessageParams: TextMessageParams(messageText: "Hi")), flyCallback: (response){
if(response.isSuccess){
var chatMessage = sendMessageModelFromJson(response.data);
print('Message sent successfully');
} else {
print('Failed to send message: ${response.errorMessage}');
}
});
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
Call Feature #

Note: To enable the Call Feature in iOS, need to enable VOIP as shown below.


To make a Video Call #
Mirrorfly.makeVideoCall(toUserJid: userJID,flyCallBack: (FlyResponse response) {
if (response.isSuccess) {

} else {

}
});
copied to clipboard
To make a Voice Call #
Mirrorfly.makeVoiceCall(toUserJid: userJID,flyCallBack: (FlyResponse response) {
if (response.isSuccess) {

} else {

}
});
copied to clipboard

Note: Provide Microphone and Camera permission and usage description in the iOS plist and Android Manifest file of your project.

To make a Group Voice Call #
Mirrorfly.makeGroupVoiceCall(groupJid: GROUP_ID, toUserJidList: USER_LIST,flyCallBack: (FlyResponse response) {
if (response.isSuccess) {

} else {

}
});
copied to clipboard
To make a Group Video Call #
Mirrorfly.makeGroupVideoCall(groupJid: GROUP_ID, toUserJidList: USER_LIST,flyCallBack: (FlyResponse response) {
if (response.isSuccess) {

} else {

}
});
copied to clipboard
Try the sample app #
The fastest way to test Mirrorfly Plugin for Flutter 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