Let's integrate our SDK in few minutes
MirrorFly Chat SDK V1 is no longer supported as a new version is released. Check out our latest Chat SDK V2 here.
To migrate from MirrorFly Chat SDK V1 to V2 please follow the Migration guide steps.
#Chat SDKs for Android
With CONTUS MirrorFly Chat SDK for Android, you can easily add real-time chat features to your client app within 30 minutes.
Through our client SDK, you can initialize and configure chat into your app with minimal efforts.
Note : If you're looking for the fastest way to build your app’s UI with MirrorFly Chat SDKs, you can use our sample apps. To get our sample apps, click here
#Integrate the Chat SDK
The requirements for chat SDK for Android are:
- Android Lollipop 5.0 (API Level 21) or above
- Java 7 or higher
- Gradle 4.1.0 or higher
#Things To Be Noted Before You Get Started
#SDK License Key
To integrate MirrorFly Chat SDK into your app, you will need a SDK License Key. The MirrorFly server will use this license key to authenticate the SDK in your application.
#To get the License Key,
Step 1: Sign up for a MirrorFly Account
Step 2: Log into your Account
Step 3: Get the License key from the
application Info’ section
Step 4: Download the Android SDK
As soon as the AAR files have been imported from the zip file using Kotlin, you can start over with the integration process.
Step 1: Create a new project or Open an existing project in Android Studio
Step 2: Add the following libraries in app/libs folder in the project
Step 3: Add the below code in the app/build.gradle file.
Step 4: Add the following dependencies in the app/build.gradle file.
Step 5: Add the below dependencies required by the SDK in the app/build.gradle file.
Step 6: Add the below line in the project level build.gradle file, to resolve library dependencies.
Step 7: Add the below line in the gradle.properties file, to avoid imported library conflicts.
Step 8: Open the AndroidManifest.xml and add below permissions.
#Configure in app/build.gradle file
You can copy the license key from the 'Overview’ section in the Console dashboard.
#Initialize Chat SDK
To start using the sdk, there is a need for some basic requirements before proceeding with the initialization process. Thus, the ChatSDK builder class is used to provide the necessary data to the SDK. In your
Application class, inside the onCreate() method use the below ChatSDK Builder to provide the necessary data.
#Chat Builder Function Description
|setDomainBaseUrl||Url is provided to make API calls|
|setLicenseKey||License key is required to proceed with registration|
|setIsTrialLicenceKey||If the provided license key is for trial version, display the text as ‘true’ else ‘false’|
|build||n/a||Initializes the chat configuration|
The base URL must have the Http/Https protocol which must be closed with a ‘slash (/)’, if not an exception - a bug message will pop up.
The below method to register a user in sandbox Live mode based on
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
registerUsermethod will accept the
FORCE_REGISTERas an optional param and pass it across.
|USER_IDENTIFIER||A unique Id to Register the User. We accept only the AlphaNumeric String|
|FCM_TOKEN||A registration token that is generated by FCM SDK for the user's app instance to send message for free|
|USER_TYPE||type of the user|
|CALLBACK||FlyCallback is used as a callback, implemented and expressed as lambda expression for easy reading|
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.
#Connect to the Chat Server
In order to send messages using the Chat SDK, at first you need to establish the connection to the server. SDK provides methods for initialize the chat connection.
Note: The ChatManager.connect() method should be called only once in an application. SDK will handle the chat server connection and disconnection automatically.
|CALLBACK||callback listener for chat connection|
Some of the most common terminologies used in Chat SDK with description
|userID/userBareID||Unique ID assigned for each user Ex: 12345678 (any alphanumeric). The below characters is not allowed in userId: U+0022 (") U+0026 (&) U+0027 (') U+002F (/) U+003A (:) U+003C (<) U+003E (>) U+0040 (@) userID should follow below specification: https://xmpp.org/extensions/xep-0106.html|
|userJid (or) JID||userID+@+domain of the chat server Ex. firstname.lastname@example.org|
|groupID/groupBareID||Unique ID assigned for each group Ex: group123456 (any alphanumeric). GroupJID = groupID +@mix.+domain of the chat server Ex: email@example.com`|
SDK will have built-in functions to prepare the JID, Group JID, and more.
#Send a One-to-One Message
Use the below method to send a text message to other user,
Note: To generate a unique user id, you must call the other user's
String userJID = FlyUtils.getJid(USERNAME)
|TO_JID||String||JID of the end user|
|TEXT||String||Indicates the text message that needs to be sent|
|REPLY_MESSAGE_ID||String||Specifies the Message ID of replied message|
|CALLBACK||callback to observe the action status|
#Receive a One-to-One Message
You can extend the
FlyBaseActivity from SDK into your app
BaseActivity, and observe all the incoming messages and other feature listeners.
Moreover, 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