Official Android SDK for Applozic Real-time Chat & Messaging. Powerful client, offline support, and UI component libraries for awesome in-app chat features.
Applozic brings real-time engagement with chat, video, and voice to your web, mobile, and conversational apps. We power emerging startups and established companies with the most scalable and powerful chat APIs, enabling application product teams to drive better user engagement, and reduce time-to-market.
Customers and developers from over 50+ countries use us and love us, from online marketplaces and eCommerce to on-demand services, to Education Tech, Health Tech, Gaming, Live-Streaming, and more.
Our feature-rich product includes robust client-side SDKs for iOS, Android, React Native, and Flutter. We also support popular server-side languages, a beautifully customizable UI kit, and flexible platform APIs.
Chat, video, and audio-calling have become the new norm in the post-COVID era, and we're bridging the gap between businesses and customers by delivering those exact solutions.
:one: Android Studio (latest version recommended)
:two: Android Device | Emulator
with Android Version 6.0+.
:three: Sign-Up or Login to get your Applozic's API/Application Key.
Before getting started with installation. We recommend to go through some basic documentation for Android Chat & Messaging SDK Documentation :memo:
dependencies{}
.implementation 'com.applozic.communication.uiwidget:mobicomkitui:5.103.0'
Note: Versions from v5.99.0 and onwards will be hosted at Jfrog Artifactory.
Add the following repo to you project level build.gradle inside allProjects { repositories { ... }}:
maven {
url 'https://applozic.jfrog.io/artifactory/applozic-android-sdk'
}
Older versions can still be consumed from Jcenter.
android{}
target: 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'
}
Note:
<application> </application>
<!-- Applozic App ID -->
<meta-data android:name="com.applozic.application.key"
android:value="<YOUR_APPLOZIC_APP_ID" />
<!-- Launcher white Icon -->
<meta-data android:name="com.applozic.mobicomkit.notification.smallIcon"
android:resource="YOUR_LAUNCHER_SMALL_ICON" />
<!-- Notification color -->
<meta-data android:name="com.applozic.mobicomkit.notification.color"
android:resource="YOUR_NOTIFICATION_COLOR_RESOURCE" />
<!--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="com.google.android.geo.API_KEY"
android:value="YOUR_GEO_API_KEY" />
<!-- NOTE: Do NOT change this, it should remain same i.e 'com.package.name' -->
<meta-data android:name="com.package.name"
android:value="${applicationId}" />
Note: If you are not using gradle build you need to replace ${applicationId}
with your Android app package name
<string name="default_media_location_folder">YOUR_APP_NAME</string>
<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"
tools:node="replace">
<!-- Parent activity meta-data to support API level 7+ -->
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value="<APP_PARENT_ACTIVITY>" />
</activity>
<!-- you will be having .MainActivity-->
<activity android:name="com.applozic.mobicomkit.uiwidgets.conversation.activity.ConversationActivity"
android:configChanges="keyboardHidden|screenSize|smallestScreenSize|screenLayout|orientation"
android:label="@string/app_name"
android:parentActivityName=".MainActivity"
android:theme="@style/ApplozicTheme"
android:launchMode="singleTask"
tools:node="replace">
<!-- Parent activity meta-data to support API level 7+ -->
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value=".MainActivity" />
</activity>
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
Applozic.connectUser(context, user, new AlLoginHandler() {
@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
}
});
If it is a new user, new user account will get created else existing user will be logged in to the application. You can check if user is logged in to applozic or not by using Applozic.isConnected(context)
Note : Go to Applozic Dashboard, Edit Application -> Push Notification -> Android -> GCM/FCM Server Key.
if(MobiComUserPreference.getInstance(context).isRegistered()) {
Applozic.registerForPushNotification(context, registrationToken, new AlPushNotificationHandler() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
});
}
if (MobiComUserPreference.getInstance(this).isRegistered()) {
new RegisterUserClientService(this).updatePushNotificationId(registrationToken);
}
if (MobiComPushReceiver.isMobiComPushNotification(remoteMessage.getData())) {
MobiComPushReceiver.processMessageAsync(this, remoteMessage.getData());
return;
}
if(MobiComUserPreference.getInstance(context).isRegistered()) {
Applozic.registerForPushNotification(context, registrationToken, new AlPushNotificationHandler() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
});
}
if (MobiComUserPreference.getInstance(this).isRegistered()) {
new RegisterUserClientService(this).updatePushNotificationId(registrationToken);
}
if(MobiComPushReceiver.isMobiComPushNotification(data)) {
MobiComPushReceiver.processMessageAsync(this, data);
return;
}
To Enable Android Push Notification using Firebase Cloud Messaging (FCM)
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
And add below code in your androidmanifest.xml file
<service android:name="<CLASS_PACKAGE>.FcmListenerService"
android:stopWithTask="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
Applozic.registerForPushNotification(context, Applozic.getInstance(context).getDeviceRegistrationId(), new AlPushNotificationHandler() {
@Override
public void onSuccess(RegistrationResponse registrationResponse) {
}
@Override
public void onFailure(RegistrationResponse registrationResponse, Exception exception) {
}
});
Intent intent = new Intent(this, ConversationActivity.class);
startActivity(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.
intent.putExtra(ConversationUIService.TAKE_ORDER,true); //Skip chat list for showing on back press
startActivity(intent);
Applozic.logoutUser(context, new AlLogoutHandler() {
@Override
public void onSuccess(Context context) {
}
@Override
public void onFailure(Exception exception) {
}
});
Trying out the demo app:
ApplozicClient.getInstance(this).setHandleDisplayName(false);
v5.98 has been released! Please see the release notes for details.
All updates to this library are documented in our releases. For any queries, feel free to reach out us at [email protected]
If you are interested in the future direction of this project, please take a look at our open issues and pull requests.
We would :heart: to hear your feedback.
We provide support over at StackOverflow when you tag using applozic, ask us anything.
Applozic is the best android chat sdk for instant messaging, still not convinced?
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
This code library fully developed and supported by Applozic's team of contributors:sunglasses: and licensed under the BSD-3 Clause License.