Skip to content
Demo Application for Webim SDK for Android
Branch: master
Clone or download
Latest commit 4bb0b40 Apr 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo Version 3.27.3 Apr 16, 2019
gradle/wrapper Version 3.5.0 Nov 20, 2017
sdk Version 3.27.3 Apr 16, 2019
.gitignore Version 3.0.0 Mar 31, 2017
LICENSE Version 3.0.0 Mar 31, 2017
README.md Version 3.27.3 Apr 16, 2019
build.gradle Version 3.20.1 Jun 27, 2018
gradle.properties Version 3.27.1 Mar 14, 2019
gradlew Version 3.0.0 Mar 31, 2017
gradlew.bat Version 3.0.0 Mar 31, 2017
settings.gradle Version 3.27.2 Mar 19, 2019

README.md

Webim SDK demo

Download Application demonstrates capabilities of Webim Android SDK. This application is published on Google Play.

Webim online consultant is a multifunctional service for consulting vistors of your site using pop-up chat — it can be freely downloaded and installed as a universal script or CMS module on required web pages and can also be integrated into a mobile trading application. Webim Android SDK library provides developers of Google Android mobile applications with tools for integration a chat between users and operators of a developer company into those applications based on technologies used in Webim online consultant.

On the one hand this application was created to demonstrate capabilities of our SDK, on the other hand to show how to use our SDK correctly. While integrating chat into your own application be guided by this demo application - it can greatly simplify the integration.

SDK Installation

Supported Android 4.+ (Android API 15+) versions To start using Webim Android SDK add a dependency to build.gradle of your application.

compile 'com.webimapp.sdk:webimclientsdkandroid:3.27.3'

Also add to AndroidManifest.xml the following permissions:

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

Usage

The public API is only in com.webimapp.android.sdk package. All the nested packages are used exclusively for SDK internal needs.

WebimSession

To get started with the chat, you need to get WebimSession object.

WebimSession sessoin = Webim.newSessionBuilder()
    .setContext(context) // Activity ot Application
    .setErrorHandler(errorHandler) // implementation of FatalErrorHandler
    .setAccountName("demo") // Webim account name
    .setLocation("mobile") // Use "mobile" if in doubt
    .build()

For this you need to decide on a location and an account of Webim service. Webim.newSessionBuilder() method returns builder object containing large number of session configuration methods. Read more about each of them in javadoc.

build() method must be called from the thread having android.os.Looper associated object (usually it is the main thread). Further, any work with the session must be performed from the same thread in which context the session was created (at a call of any session method it is checked which thread it was called from). All the callbacks are also performed in context of the same thread the session was created in.

Webim session contains methods for managing the network: resume(), pause(), destroy().Initially, the session is created paused, i.e. to start using it, the first thing you need to do is to call resume(). pause() again suspends the session, i.e. stops use of network resources. destroy() method, for its part, completely releases all the resources occupied by the session and after its call session recovery is impossible (when calling any session method it is dropped IllegalStateException). destroy() and pause() methods are allowed to call on the destroyed session (no action is performed).This is done for integration with the Activity lifecycle. It is recommended to call pause() from Activity.onStop(), resume() from Activity.onStart(), destroy() from Activity.onDestroy().

getStream() method returns MessageStream object, all the rest of work with a chat is done by using it.

View message history

SDK allows to view a message history and track history changes (editing/deleting messages). For this, it is used object MessageTracker returned by MessageStream.newMessageTracker(MessageListener) method. At each call of MessageTracker.getNextMessages(int, GetMessagesCallback) callback gets the next batch of the messages above in the history. At the same time MessageTracker saves the requested interval of the messages and tracks changes in this interval. These changes are transmitted to an object implementing MessageListener interface which is necessary to transmit to MessageStream.newMessageTracker(MessageListener) method when creating MessageTracker object. MessageListener will also receive new messages.

Sending messages

To send messages MessageStream.sendMessage(String) method is used. At the same time the message to be sent is immediately received at MessageListener.messageAdded (if there is an active MessageTracker). After confirmation of receiving the message the server calls a MessageListener.messageChanged method with an already current message.

Working with push-notifications

At the beginning you must configure a session to work with push-notifications. For this, you must call SessionBuilder.setPushSystem(PushSystem.GCM) method. As a result Webim service will send push notifications to your device. Received pushes pass our SDK by unnoticed and in your application you must accept them by yourself. An example you can watch in the demo-appplication. After a push is received you must compare the field from with Webim.getGcmSenderId()and if they match, it means this push was sent by Webim service. Then to deserialize push data Webim.parseGcmPushNotification(Bundle)method is used.

if(intent.getStringExtra("from").equals(Webim.getGcmSenderId())) {
    WebimPushNotification push = Webim.parseGcmPushNotification(intent.getExtras());
    // process webim push-notification
} else {
    // process your application push-notification
}
You can’t perform that action at this time.