fanapsoft / pod-chat-android-sdk

Fanap's Podchat Android SDK

a chat sdk for android

Contents

• Installation

• Connect

• Add a contact

• Create a thread

• Send Message to thread

• Custom Configurations

• FAQ

Installation

Project build.gradle

allprojects {
    repositories {
        jcenter()
        google()
        maven { url "https://s3.amazonaws.com/repo.commonsware.com" }
     }
    }

App build.gradle

implementation("com.fanap.chat:podchat:$chatSdkVersion")

Initial

    Chat chat = Chat.init(Context);


    chat.isCacheables(true); //use caching

    chat.isLoggable(true); //log requests and responses

    chat.rawLog(true); //log everything

Connect

    RequestConnect rc = new RequestConnect.Builder(
                    socketAddress, 
                    APP_ID,
                    serverName,
                    TOKEN,
                    ssoHost,
                    platformHost,
                    fileServer,
                    podSpaceServer)
                .build();


     chat.addListener(new ChatListener() {

            @Override
            public void onChatState(String state) {

                if (state.equals(ChatStateType.ChatSateConstant.CHAT_READY))
                {

                    chatReady = true;

                    Log.i(TAG, "Hello there!");

                    Log.d(TAG, "Chat Is Ready! :) ");

                } 
                else 
                {
                    chatReady = false;

                    Log.d(TAG, "Connecting...");

                }
            
            }

            @Override
            public void onError(String content, ErrorOutPut error) {


                // token expired!

                if(error.getErrorCode() == 21){

                    newToken = getNewToken();

                    chat.setToken(newTOken);

                    returen;
                }

                Log.d(TAG, "Ops :'( " + content);
                Log.d(TAG, "Error Code: " + error.getErrorCode());
                Log.d(TAG, "Cause: " + error.getErrorMessage());
                Log.d(TAG, "UniqueID: " + error.getUniqueId());

            }
        });




    chat.connect(requestConnect);

Add Contacts

Add a contact to your chat contacts list

RequestAddContact request = new RequestAddContact.Builder()
                    .firstName("John") 
                    .lastName("Doe")

// add with their username in chat 

//                   .username("j.doe123") 
// or
//                   .email([email protected])
// or
//                   .cellphoneNumber(09*********)

                    .build();

chat.addContact(request);

One of firstName or lastName is required.

Callback:

onContactAdded(String content, ChatResponse<ResultAddContact> response)

Create a thread

List<Invitee> invite = new ArrayList<>();

invite.add(new Invitee("j.doe123", InviteType.Constants.TO_BE_USER_USERNAME));

Other inviteTypes:

TO_BE_USER_SSO_ID,
TO_BE_USER_CONTACT_ID,
TO_BE_USER_CELLPHONE_NUMBER,
TO_BE_USER_ID,

RequestCreateThread requestCreateThread = new RequestCreateThread
                .Builder(ThreadType.Constants.NORMAL, invite)
                .title("Sample Thread")
                .withDescription("This is description")
                .withMetadata("
                                    {
                                      "sampleKey1": 1998,
                                      "sampleKey2": "some special info"
                                    }
                               ")
                .setUploadThreadImageRequest(requestUploadImage)
                .build();


chat.createThread(requestCreateThread)

.setUploadThreadImageRequest(requestUploadImage) set an image for thread:

 RequestUploadImage requestUploadImage = new RequestUploadImage.Builder(Activity, Uri)
                        //crop parameters:
                       .sethC(140) //image height
                       .setwC(140) //image width
                       .build();

Callback:

onCreateThread(String content, ChatResponse<ResultThread> response)

Send a Message to thread

RequestMessage req = new RequestMessage.Builder("Hello World!", threadId)
                    .messageType(TextMessageType.Constants.TEXT)
                    .build();


chat.sendTextMessage(req, null);

Callbacks:

onSent(String content, ChatResponse<ResultMessage> chatResponse) //when the message is sent successfully.
 
onDeliver(String content, ChatResponse<ResultMessage> chatResponse) //when the message is deliver to partner.

onSeen(String content, ChatResponse<ResultMessage> response) //when the message is seen by partner. 

Custom Configurations

Notification

Set custom config and enable push notification

CustomNotificationConfig notificationConfig = new CustomNotificationConfig
                .Builder(ChatActivity.class.getName()) //this is the activity that launches when a notification clicked
                .setChannelName("SAMPLE_CHAT_CHANNEL")
                .setChannelId("PODCHAT")
                .setChannelDescription("Fanap soft podchat notification channel")
                .setIcon(R.mipmap.ic_launcher)
                .setNotificationImportance(NotificationManager.IMPORTANCE_DEFAULT)
                .build();


chat.setupNotification(notificationConfig);

Get clicked notification data in 'target' activity

 if (getIntent() != null && getIntent().getExtras() != null) {

            Bundle a = getIntent().getExtras();

            String threadId = a.getString("threadId");

            String messageId = a.getString("messageId");

            Log.d("TAG", "Notification Data: ");
            Log.d("TAG", "Thread Id: " + threadId);
            Log.d("TAG", "Message Id: " + messageId);


        }

and clear thread notifications from notificatin bar

if (Util.isNotNullOrEmpty(threadId))
      chat.deliverNotification(threadId);

Clear all notification from notification bar

chat.clearAllNotifications();

Connection

Set NetworkStateConfig to stay stable in network issues

NetworkPingSender.NetworkStateConfig npsConfig = new NetworkPingSender.NetworkStateConfig()
                .setHostName("8.8.4.4") //google or your own host for sending ping
                .setPort(443) // default ping port
                .setDisConnectionThreshold(2) //how many time a disconnection detects and skips
                .setInterval(7000) // interval between pings
                .setConnectTimeout(10000) //ping timeout
                .build();
                

chat.setNetworkStateConfig(npsConfig);
.
.
.
chat.connect(requestConnect);

Timeout

Set timeout for download and upload

TimeoutConfig timeout = new TimeoutConfig()
                .newConfigBuilder()
                .withConnectTimeout(30, TimeUnit.SECONDS)
                .withWriteTimeout(30, TimeUnit.MINUTES)
                .withReadTimeout(30, TimeUnit.MINUTES)
                .build();


chat.setUploadTimeoutConfig(timeout);

chat.setDownloadTimeoutConfig(timeout);