Channel SDK for Android
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
app
channel
gradle/wrapper
.gitignore
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Channel SDK for Android

Channel SDK is a library designed to simplify the development with our API.

How to use Channel SDK in your Android app

1. Download our SDK from Release page

2. Add maven repositories and config library directory in your project build.gradle

allprojects {
 repositories {
     jcenter()
     maven { url "https://jitpack.io"} // maven repository
     flatDir{dirs 'libs'} //direct path to your library folder
 }
}

3. Add dependencies to your project build.gradle

classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.1'

4. Add code below to your module build.gradle

    api (name: 'channel', ext:'aar')
    // image picker
    api 'com.github.jkwiecien:EasyImage:1.3.1'
    // dialog required
    api 'com.afollestad.material-dialogs:core:0.9.0.2'
    // chatkit required
    api 'com.google.android:flexbox:0.2.5'
    api 'com.android.support:appcompat-v7:27+'
    api 'com.android.support:cardview-v7:27+'
    api 'com.android.support:design:27+'
    api 'com.github.siyamed:android-shape-imageview:0.9.3'
    //Utils
    api 'me.relex:circleindicator:1.2.2@aar'

5. Setup Channel application key in your main activity

 Channel.setupApplicationContextWithApplicationKey(<Your Application Context>, new ChannelCallback() {
           @Override
           public void onSuccess() {
   			//place your code when success
           }

           @Override
           public void onFail(String message) {
   			//Handle error with fail message
           }
       });

5. This is informations when opening the Channel chatview is required

HashMap<String,String> yourClientData =  new HashMap<String,String>();
yourClientData.put("name","YOUR CLIENT NAME");
yourClientData.put("lastname","YOUR CLIENT LASTNAME");
Channel.chatViewWithUserID(<Your Activity>,"YOUR_APP_USER_ID", userData);

or

Channel.chatView(<Your Activity>);

6. Show Channel in-app notification

//send display target Activity
Channel.showLatestNotification(activity, new ChannelCallback() {
           @Override
           public void onSuccess() {
   			//place your code when success
           }

           @Override
           public void onFail(String message) {
   			//Handle error with fail message
           }
       });

7. Register device token

Channel.saveDeviceToken("DEVICE_TOKEN", new ChannelCallback() {
           @Override
           public void onSuccess() {
   			//place your code when success
           }

           @Override
           public void onFail(String message) {
   			//Handle error with fail message
           }
       });

8. Send Firebase message to Channel for notification status tracking

public class MyFirebaseMessagingService extends FirebaseMessagingService {
   @Override
   public void onMessageReceived(RemoteMessage remoteMessage) {
  Channel.postbackPushNotification(remoteMessage.getData(), new ChannelCallback() {
           @Override
           public void onSuccess() {
               //place your code when success
           }

           @Override
           public void onFail(String message) {
   			//Handle error with fail message
           }
       });
   }
}