Android Chat SDK
Open source Android Chat SDK / Messaging SDK that lets you add real time chat and in-app messaging in your mobile (android, iOS) applications and website.
Signup at https://www.applozic.com/signup.html to get the application key.
Applozic One to One and Group Chat SDK
To integrate android chat library into your android app, signup at Applozic to get the application key.
Documentation: Applozic Android Chat & Messaging SDK Documentation
Step 1: Add the following in your build.gradle dependency:
compile 'com.applozic.communication.uiwidget:mobicomkitui:4.80'
Add the following in gradle android target:
android {
packagingOptions {
exclude 'META-INF/DEPENDENCIES'
exclude 'META-INF/NOTICE'
exclude 'META-INF/LICENSE'
exclude 'META-INF/LICENSE.txt'
exclude 'META-INF/NOTICE.txt'
exclude 'META-INF/ECLIPSE_.SF'
exclude 'META-INF/ECLIPSE_.RSA'
}
}
Step 2: Addition of Permissions,Activities, Services and Receivers in androidmanifest.xml:
Note: Add meta-data, Activities, Services and Receivers within application Tag <application> </application>
Note: Add Permissions outside the application Tag <application>
<meta-data android:name="com.applozic.application.key"
android:value="YOUR_APPLOZIC_APPLICATION_KEY" /> <!-- Applozic Application Key -->
<meta-data android:name="com.applozic.mobicomkit.notification.smallIcon"
android:resource="YOUR_LAUNCHER_SMALL_ICON" /> <!-- Launcher white Icon -->
<meta-data android:name="main_folder_name"
android:value="@string/default_media_location_folder" /> <!-- Attachment Folder Name -->
<meta-data android:name="com.google.android.geo.API_KEY"
android:value="YOUR_GEO_API_KEY" /> <!--Replace with your geo api key from google developer console -->
<!-- For testing purpose use AIzaSyAYB1vPc4cpn_FJv68eS_ZGe1UasBNwxLI
To disable the location sharing via map add this line ApplozicSetting.getInstance(context).disableLocationSharingViaMap(); in onSuccess of Applozic UserLoginTask -->
<meta-data android:name="activity.open.on.notification"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" /> <!-- NOTE : Do NOT change this value -->
<meta-data android:name="com.package.name"
android:value="${applicationId}" /> <!-- NOTE: Do NOT change this, it should remain same i.e 'com.package.name' -->
<provider android:name="android.support.v4.content.FileProvider"
android:authorities="${applicationId}.provider"
android:exported="false"
android:grantUriPermissions="true">
<meta-data android:name="android.support.FILE_PROVIDER_PATHS"
android:resource="@xml/provider_paths"/>
</provider>
Note: If you are not using gradle build you need to replace ${applicationId} with your Android app package name
Define Attachment Folder Name in your string.xml.
<string name="default_media_location_folder">YOUR_APP_NAME</string>
Adding File Provider path in your app
1.Create a android resorce directory as xml directory
2.Create a XML resource file in xml directory as provider_paths and paste the below code
<?xml version="1.0" encoding="utf-8"?>
<paths>
<external-path name="files" path="."/>
</paths>
Permissions:
<uses-permission android:name="<APP_PKG_NAME>.permission.MAPS_RECEIVE" />
<permission android:name="<APP_PKG_NAME>.permission.MAPS_RECEIVE" android:protectionLevel="signature" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_CONTACTS" />
<uses-permission android:name="android.permission.VIBRATE"/>
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.CALL_PHONE" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
Broadcast Registration For PushNotification:
<receiver android:name="com.applozic.mobicomkit.uiwidgets.notification.MTNotificationBroadcastReceiver">
<intent-filter>
<action android:name="${applicationId}.send.notification"/>
</intent-filter>
</receiver>
Note: If you are not using gradle build you need to replace ${applicationId} with your Android app package name
Paste the following in your androidmanifest.xml:
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:label="@string/app_name"
android:parentActivityName="<APP_PARENT_ACTIVITY>"
android:theme="@style/ApplozicTheme"
android:launchMode="singleTask" >
<!-- Parent activity meta-data to support API level 7+ -->
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="<APP_PARENT_ACTIVITY>" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.people.activity.MobiComKitPeopleActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:label="@string/activity_contacts_list"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme"
android:windowSoftInputMode="adjustResize">
<!-- Parent activity meta-data to support API level 7+ -->
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
<intent-filter>
<action android:name="android.intent.action.SEARCH" />
</intent-filter>
<meta-data
android:name="android.app.searchable"
android:resource="@xml/searchable_contacts" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.FullScreenImageActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:label="Image"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/Applozic_FullScreen_Theme">
<!-- Parent activity meta-data to support API level 7+ -->
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ContactSelectionActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:launchMode="singleTop"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme">
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ChannelCreateActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:launchMode="singleTop"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme">
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ChannelNameActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:launchMode="singleTop"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme">
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ChannelInfoActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:launchMode="singleTop"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme">
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.MobiComAttachmentSelectorActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:launchMode="singleTop"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme"
android:windowSoftInputMode="stateHidden|adjustResize">
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity" />
</activity>
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.MobicomLocationActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:parentActivityName="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:theme="@style/ApplozicTheme"
android:windowSoftInputMode="adjustResize">
</activity>
<activity android:name="com.theartofdev.edmodo.cropper.CropImageActivity"
android:theme="@style/Base.Theme.AppCompat"/>
<service android:name="com.applozic.mobicomkit.api.conversation.MessageIntentService"
android:exported="false" />
<service android:name="org.eclipse.paho.android.service.MqttService"/>
<service android:name="com.applozic.mobicomkit.api.conversation.ApplozicIntentService"
android:exported="false" />
<service android:name="com.applozic.mobicomkit.api.conversation.ApplozicMqttIntentService"
android:exported="false" />
<service android:name="com.applozic.mobicomkit.api.people.UserIntentService"
android:exported="false" />
<service android:name="com.applozic.mobicomkit.api.conversation.ConversationIntentService"
android:exported="false" />
<service android:name="com.applozic.mobicomkit.api.conversation.ConversationReadService"
android:exported="false" />
<receiver android:name="com.applozic.mobicomkit.broadcast.TimeChangeBroadcastReceiver">
<intent-filter>
<action android:name="android.intent.action.TIME_SET" />
<action android:name="android.intent.action.TIMEZONE_CHANGED" />
</intent-filter>
</receiver>
<receiver android:name="com.applozic.mobicomkit.broadcast.ConnectivityReceiver"
android:exported="true" android:enabled="true">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
</intent-filter>
</receiver>
Replace APP_PARENT_ACTIVITY with your app's parent activity.
Step 3: Register user account:
UserLoginTask.TaskListener listener = new UserLoginTask.TaskListener() {
@Override
public void onSuccess(RegistrationResponse registrationResponse, Context context) {
// After successful registration with Applozic server the callback will come here
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
// If any failure in registration the callback will come here
}};
User user = new User();
user.setUserId(userId); //userId it can be any unique user identifier
user.setDisplayName(displayName); //displayName is the name of the user which will be shown in chat messages
user.setEmail(email); //optional
user.setAuthenticationTypeId(User.AuthenticationType.APPLOZIC.getValue()); //User.AuthenticationType.APPLOZIC.getValue() for password verification from Applozic server and User.AuthenticationType.CLIENT.getValue() for access Token verification from your server set access token as password
user.setPassword(""); //optional, leave it blank for testing purpose, read this if you want to add additional security by verifying password from your server https://www.applozic.com/docs/configuration.html#access-token-url
user.setImageLink("");//optional,pass your image link
new UserLoginTask(user, listener, this).execute((Void) null);
If it is a new user, new user account will get created else existing user will be logged in to the application.
####Step 4: Push Notification Setup
Go to Applozic Dashboard, Edit Application. Under Module section, update the GCM Server Key.
Add the below code and pass the FCM registration token:
1. In UserLoginTask "onSuccess" (refer Step 3)
if(MobiComUserPreference.getInstance(context).isRegistered()) {
PushNotificationTask pushNotificationTask = null;
PushNotificationTask.TaskListener listener = new PushNotificationTask.TaskListener() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
};
pushNotificationTask = new PushNotificationTask(registrationToken, listener, mActivity);
pushNotificationTask.execute((Void) null);
}
2. In your FcmInstanceIDListenerService onTokenRefresh() method
if (MobiComUserPreference.getInstance(this).isRegistered()) {
new RegisterUserClientService(this).updatePushNotificationId(registrationToken);
}
Add the following in your FcmListenerService in onMessageReceived(RemoteMessage remoteMessage)
if (MobiComPushReceiver.isMobiComPushNotification(remoteMessage.getData())) {
MobiComPushReceiver.processMessageAsync(this, remoteMessage.getData());
return;
}
If you already have GCM enabled in your app, add the below code and pass the GCM registration token:
1. In UserLoginTask "onSuccess" (refer Step 3)
if(MobiComUserPreference.getInstance(context).isRegistered()) {
PushNotificationTask pushNotificationTask = null;
PushNotificationTask.TaskListener listener = new PushNotificationTask.TaskListener() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
};
pushNotificationTask = new PushNotificationTask(registrationToken, listener, mActivity);
pushNotificationTask.execute((Void) null);
}
2. At the place where you are getting the GCM registration token in your app.
if (MobiComUserPreference.getInstance(this).isRegistered()) {
new RegisterUserClientService(this).updatePushNotificationId(registrationToken);
}
Add the following in your GcmListenerService in onMessageReceived
if(MobiComPushReceiver.isMobiComPushNotification(data)) {
MobiComPushReceiver.processMessageAsync(this, data);
return;
}
To Enable Android Push Notification using Firebase Cloud Messaging (FCM) visit the Firebase console and create new project, add the google service json to your app, configure the build.gradle files in your app ,finally get server key from project settings and update in
Applozic Dashboard under Edit Application.
Under Module section, update the GCM Server Key.
In case, if you don't have the existing FCM related code, then copy the push notification related files from Applozic sample app to your project from the below github link
Github push notification code link
And add below code in your androidmanifest.xml file
<service android:name="<CLASS_PACKAGE>.FcmListenerService">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
<service android:name="<CLASS_PACKAGE>.FcmInstanceIDListenerService"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
</intent-filter>
</service>
####Setup PushNotificationTask in UserLoginTask "onSuccess" (refer Step 3).
PushNotificationTask pushNotificationTask = null;
PushNotificationTask.TaskListener listener= new PushNotificationTask.TaskListener() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
};
pushNotificationTask = new PushNotificationTask(Applozic.getInstance(context).getDeviceRegistrationId(),listener,context);
pushNotificationTask.execute((Void)null);
Step 5: For starting the messaging activity:
Intent intent = new Intent(this, ConversationActivity.class);
startActivity(intent);
For starting individual conversation thread, set "userId" in intent:
Intent intent = new Intent(this, ConversationActivity.class);
intent.putExtra(ConversationUIService.USER_ID, "receiveruserid123");
intent.putExtra(ConversationUIService.DISPLAY_NAME, "Receiver display name"); //put it for displaying the title.
startActivity(intent);
Step 6: On logout, call the following:
new UserClientService(this).logout();
Note: If you are running ProGuard, please add following lines:
#keep json classes
-keepclassmembernames class * extends com.applozic.mobicommons.json.JsonMarker {
!static !transient <fields>;
}
-keepclassmembernames class * extends com.applozic.mobicommons.json.JsonParcelableMarker {
!static !transient <fields>;
}
#GSON Config
-keepattributes Signature
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.examples.android.model.** { *; }
-keep class org.eclipse.paho.client.mqttv3.logging.JSR47Logger { *; }
-keep class android.support.** { *; }
-keep interface android.support.** { *; }
Trying out the demo app:
Open project in Android Studio to run the sample app in your device. Send messages between multiple devices.
Display name for users: You can either choose to handle display name from your app or have Applozic handle it. From your app's first activity, set the following to disable display name feature: ApplozicClient.getInstance(this).setHandleDisplayName(false); By default, the display name feature is enabled.
###Documentation: For advanced options and customization, visit Applozic Android Chat & Messaging SDK Documentation
###Changelog Changelog
####Features:
One to one and Group Chat
Image capture
Photo sharing
File attachment
Location sharing
Push notifications
In-App notifications
Online presence
Last seen at
Unread message count
Typing indicator
Message sent, Read Recipients and Delivery report
Offline messaging
User block / unblock
Multi Device sync
Application to user messaging
Customized chat bubble
UI Customization Toolkit
Cross Platform Support (iOS, Android & Web)
###Sample code to build messenger and chat app https://github.com/AppLozic/Applozic-Android-SDK/tree/master/app
##Help
We provide support over at [StackOverflow] (http://stackoverflow.com/questions/tagged/applozic) when you tag using applozic, ask us anything.
Applozic is the best android chat sdk for instant messaging, still not convinced? Write to us at [email protected] and we will be happy to schedule a demo for you.
###Free Android Chat SDK Special plans for startup and open source contributors, write to us at [email protected]
##Github projects
Android Chat SDK https://github.com/AppLozic/Applozic-Android-SDK
Web Chat Plugin https://github.com/AppLozic/Applozic-Web-Plugin
iOS Chat SDK https://github.com/AppLozic/Applozic-iOS-SDK