How do I handle initialization and connection when using Sendbird Live and Sendbird UIKit together?

[rimdoo]

Summary

• How do I handle initialization and connection when using Sendbird Live and Sendbird UIKit together?

Guide & Snippet

Live uses the term authenticate and UIKit uses the term connect, but I will use the term connect in the following discussion.

• When using Sendbird Live with Sendbird UIKit, how to initialize both is important.
• Both Live connect and UIKit connect use the same connection internally, the connection state is shared.
• After receiving the onInitSucceed callback from the SendbirdLive.init and SendbirdUIKit.init function, you should start UIKit and Live contents.
• For initialization, we recommend to invoke SendbirdLive.init and SendbirdUIKit.init in the Application class.

• The logic below is a custom snippet with a simple example.

import android.app.Application
import androidx.lifecycle.MutableLiveData
import com.sendbird.android.exception.SendbirdException
import com.sendbird.live.AuthenticateParams
import com.sendbird.live.InitParams
import com.sendbird.live.SendbirdLive
import com.sendbird.live.handler.InitResultHandler
import com.sendbird.uikit.SendbirdUIKit
import com.sendbird.uikit.adapter.SendbirdUIKitAdapter
import com.sendbird.uikit.interfaces.UserInfo

val APP_ID = "YOUR_APP_ID"
val USER_ID = "YOUR_USER_ID"
val USER_NICKNAME = "YOUR_USER_NICKNAME"

enum class InitState {
    /**
     * Indicates the migrating state.
     */
    MIGRATING,

    /**
     * Indicates the failed state.
     */
    FAILED,

    /**
     * Indicates the succeeded state.
     */
    SUCCEED,

    /**
     * Indicates nothing is set.
     */
    NONE,
}

class BaseApplication : Application() {

    internal val initState = MutableLiveData(InitState.NONE)

    override fun onCreate() {
        super.onCreate()
        val params = InitParams(APP_ID, applicationContext)

        SendbirdLive.init(params, object : InitResultHandler {
            override fun onInitFailed(e: com.sendbird.webrtc.SendbirdException) {}

            override fun onInitSucceed() {
                val params = AuthenticateParams(USER_ID, null)
                SendbirdLive.authenticate(params) { user, e ->
                    if (e != null) {
                        //handle error
                        return@authenticate
                    }

                    SendbirdUIKit.init(object : SendbirdUIKitAdapter {
                        override fun getAppId(): String {
                            return APP_ID // Specify your Sendbird application ID.
                        }

                        override fun getAccessToken(): String {
                            return "" // Specify your user's access token.
                        }

                        override fun getUserInfo(): UserInfo {
                            return object : UserInfo {
                                override fun getUserId(): String {
                                    return USER_ID
                                    // Use the ID of a user you've created on the dashboard.
                                }

                                override fun getNickname(): String {
                                    return USER_NICKNAME // Specify your user nickname. Optional.
                                }

                                override fun getProfileUrl(): String {
                                    return ""
                                }
                            }
                        }

                        override fun getInitResultHandler(): com.sendbird.android.handler.InitResultHandler {
                            return object : com.sendbird.android.handler.InitResultHandler {
                                override fun onMigrationStarted() {
                                    // DB migration has started.
                                }

                                override fun onInitFailed(e: SendbirdException) {
                                    TODO("Not yet implemented")
                                }

                                override fun onInitSucceed() {
                                    // If DB migration is successful, this method is called and you can proceed to the next step.
                                    initState.value = InitState.SUCCEED
                                }
                            }
                        }
                    }, this@BaseApplication)
                }
            }

            override fun onMigrationStarted() {}
        })
    }
}

You should set the BaseApplication class in the AndroidManifest.xml file.

• In your activity or your screen, you can observe the MutableLiveData<InitState> initState value and proceed to the next screen when the initialization is successful.

import android.os.Bundle
import androidx.activity.enableEdgeToEdge
import androidx.appcompat.app.AppCompatActivity
import com.sendbird.uikit.activities.ChannelListActivity

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()
        setContentView(R.layout.activity_main)

        (application as BaseApplication).initState.observe(this) {
            if (it == InitState.SUCCEED) {
                startActivity(ChannelListActivity.newIntent(this))
                finish()
            }
        }
    }
}

Reference

• UIKit: Getting started
• Live: Start your first live