Let's integrate our SDK in few minutes

Quick Start

warning

MirrorFly Chat SDK V3 is released. Check out our latest Chat SDK V3 here.

To migrate from MirrorFly Chat SDK V2 to V3 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

Getting Started

Requirements

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: Register here to get a MirrorFly User account. Registration is subject to verification and would take up to 24 hours.

Step 2: Login to your Account

Step 3: Get the License key from the application Info’ section

Integrate the Chat SDK

Step 1: Create a new project or Open an existing project in Android Studio

Step 2: If using Gradle 6.8 or higher, add the following code to your settings.gradle file. If using Gradle 6.7 or lower, add the following code to your root build.gradle file. See this release note to learn more about updates to Gradle.

Gradle 6.8 or higher

dependencyResolutionManagement {

repositories {

jcenter()

maven {

url "https://repo.mirrorfly.com/release"

}

}

}

Gradle 6.7 or lower

allprojects {

repositories {

jcenter()

maven {

url "https://repo.mirrorfly.com/release"

}

}

}

Step 3: Add the following dependencies in the app/build.gradle file.

dependencies {

implementation 'com.mirrorfly.sdk:mirrorflysdk:7.5.0'

}

Step 4: Add the below line in the gradle.properties file, to avoid imported library conflicts.

android.enableJetifier=true

Step 5: Open the AndroidManifest.xml and add below permissions.

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

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.

Java

new ChatSDK.Builder()

.setDomainBaseUrl("https://api-preprod-sandbox.mirrorfly.com/api/v1/")

.setLicenseKey(LICENSE_KEY) //Please enter your license key

.setIsTrialLicenceKey(true)

.build();

Kotlin

ChatSDK.Builder()

.setDomainBaseUrl("https://api-preprod-sandbox.mirrorfly.com/api/v1/")

.setLicenseKey(LICENSE_KEY) //Please enter your license key

.setIsTrialLicenceKey(true)

.build()

Chat Builder Function Description

Function	Parameter Type	Description
setDomainBaseUrl	String	Url is provided to make API calls
setLicenseKey	String	License key is required to proceed with registration
setIsTrialLicenceKey	boolean	If the provided license key is for trial version, display the text as ‘true’ else ‘false’
build	n/a	Initializes the chat configuration

caution

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.

Registration

The below method to register a user in sandbox Live mode based on setIsTrialLicenceKey provided.

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, FORCE_REGISTER, USER_TYPE and LIST<METADATA> as an optional param and pass it across.

Java

FlyCore.registerUser(USER_IDENTIFIER, (isSuccess, throwable, data ) -> {

if(isSuccess) {

Boolean isNewUser = (Boolean) data.get("is_new_user");

JSONObject responseObject = (JSONObject) data.get("data");

// Get Username and password from the object

} else {

// Register user failed print throwable to find the exception details.

}

});

Kotlin

FlyCore.registerUser(USER_IDENTIFIER) { isSuccess, throwable, data ->

if(isSuccess) {

val isNewUser = data["is_new_user"] as Boolean

val responseObject = data.get("data") as JSONObject

// Get Username and password from the object

} else {

// Register user failed print throwable to find the exception details.

}

}

Argument	Type	Description
USER_IDENTIFIER	String	A unique Id to Register the User. We accept only the AlphaNumeric String
FCM_TOKEN	String	A registration token that is generated by FCM SDK for the user's app instance to send message for free
FORCE_REGISTER	boolean	default value true provide true to force the logout of the old session If the registered user has reached the maximum no of multi-sessions or provide false to allow registration till the maximum no of multi-sessions
USER_TYPE	String	type of the user
META_DATA	List<MetaData>	list of key - value pair of metadata object. Maximum size is 3
CALLBACK	FlyCallback	FlyCallback is used as a callback, implemented and expressed as lambda expression for easy reading

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.

Connect to the Chat Server

Once Registration was successful, ChatSDK automatically attempts to connect to the Chat Server and ChatSDK also observe the changes in application lifecycle, and accordingly it will try to connect and disconnect the Chat Server.

Observe Connection Events

Once the ChatConnectionListener has been set, you will be able to receive the connection status in the callback method as mentioned below.

Java

ChatManager.setConnectionListener(new ChatConnectionListener() {

@Override

public void onConnected() {

// Write your success logic here to navigate Profile Page or

// To Start your one-one chat with your friends

}

@Override

public void onDisconnected() {

// Connection disconnected

}

@Override

public void onConnectionFailed(@NonNull FlyException e) {

// Connection Not authorized or Unable to establish connection with server

}

@Override

public void onReconnecting() {

// Automatic reconnection enabled

}

});

Kotlin

ChatManager.setConnectionListener(object : ChatConnectionListener {

override fun onConnected() {

// Write your success logic here to navigate Profile Page or

// To Start your one-one chat with your friends

}

override fun onDisconnected() {

// Connection disconnected

}

override fun onConnectionFailed(e: FlyException) {

// Connection Not authorized or Unable to establish connection with server

}

override fun onReconnecting() {

// Automatic reconnection enabled

}

})

Argument	Type	Description
CALLBACK	ChatConnectionListener	callback listener for chat connection

Terminology

Some of the most common terminologies used in Chat SDK with description

keyword	Explanation
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. 12345678@xmpp.chatsystem.dev.contus.us
groupID/groupBareID	Unique ID assigned for each group Ex: group123456 (any alphanumeric). GroupJID = groupID +@mix.+domain of the chat server Ex: group123456@mix.xmpp.mirrorfly.dev.contus.us`

info

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 username method String userJID = FlyUtils.getJid(USERNAME)

Java

FlyMessenger.sendTextMessage(TO_JID, TEXT, new SendMessageListener() {

@Override

public void onResponse(boolean isSuccess, @Nullable ChatMessage chatMessage) {

// you will get the message sent success response

}

});

Kotlin

FlyMessenger.sendTextMessage(TO_JID, TEXT, listener = object : SendMessageListener {

override fun onResponse(isSuccess: Boolean, chatMessage: ChatMessage?) {

// you will get the message sent success response

}

})

Argument	Type	Description
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	SendMessageListener	callback to observe the action status

Receive a One-to-One Message

You need to initialise observer MessageEventsListener to recieve any message and observe all the incoming messages sent to you.

Java

ChatEventsManager.setupMessageEventListener(new MessageEventsListener() {

@Override

public void onMessageReceived(@NotNull ChatMessage message) {

//called when the new message is received

}

});

Kotlin

ChatEventsManager.setupMessageEventListener(object : MessageEventsListener {

override fun onMessageReceived(message: ChatMessage) {

//called when the new message is received

}

})

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

Java

@Override

public void onMessageReceived(@NonNull ChatMessage message) {

super.onMessageReceived(message);

// received message object

}

Kotlin

override fun onMessageReceived(message: ChatMessage) {

super.onMessageReceived(message)

// received message object

}