Android Kotlin SDK

Easy / Managed UI preview

Use this when the Android app wants Ringnity to draw the support screen. The view includes Chat, AI, audio/video call controls, ringtone hooks, and optional video view injection.

import com.ringnity.sdk.Ringnity
import com.ringnity.sdk.RingnityConfig
import com.ringnity.sdk.RingnityCallMode
import com.ringnity.sdk.android.RingnityAndroidCallAdapter
import com.ringnity.sdk.android.RingnityAndroidManagedView

val callAdapter = RingnityAndroidCallAdapter(applicationContext)
val ringnity = Ringnity.create(
    RingnityConfig(
        tokenProvider = ::fetchRingnityToken,
        callMode = RingnityCallMode.BASIC,
        mediaAdapter = callAdapter,
        notificationAdapter = callAdapter,
        realtimeTransport = RingnitySocketIoRealtimeTransport()
    )
)

val supportView = RingnityAndroidManagedView(this)

// Optional: inject your own native video views.
supportView.setRemoteVideoView(remoteVideoView)
supportView.setLocalPreviewView(localPreviewView)

supportView.bind(
    ringnity = ringnity,
    conversationSubject = "Android customer support"
)

setContentView(supportView)

Modular native views

Use these when the Android app owns navigation and wants only one Ringnity surface on a screen.

val chatView = RingnityAndroidChatView(this)
chatView.bind(
    ringnity = ringnity,
    conversationSubject = "Android customer support"
)

val aiView = RingnityAndroidAiView(this)
aiView.bind(ringnity)

val callView = RingnityAndroidCallView(this)
callView.setRemoteVideoView(remoteVideoView)
callView.setLocalPreviewView(localPreviewView)
callView.bind(
    ringnity = ringnity,
    conversationSubject = "Android customer support"
)

Headless Kotlin object model

val callAdapter = RingnityAndroidCallAdapter(applicationContext)
val permissions = callAdapter.permissions(video = true)

if (!permissions.canStartVideo) {
    // Request microphone/camera permission with your Activity permission flow.
}

val ringnity = Ringnity.create(
    RingnityConfig(
        tokenProvider = {
            val token = customerBackend.fetchRuntimeToken()
            RingnityRuntimeToken(
                token = token.token,
                expiresIn = token.expiresIn
            )
        },
        callMode = RingnityCallMode.BASIC,
        mediaAdapter = callAdapter,
        notificationAdapter = callAdapter,
        notifications = RingnityNotificationPreferences(
            incomingCall = RingnityRingtoneOptions(
                soundName = "ringnity_default",
                vibrate = true
            )
        )
    )
)

val readiness = ringnity.account.readiness()

val conversation = ringnity.chat.createConversation(
    subject = "Need help"
)
val conversationId = conversation["conversationId"] as String

ringnity.devices.registerPushToken(
    platform = RingnityPushPlatform.ANDROID,
    provider = RingnityPushProvider.FCM,
    token = firebaseMessagingToken,
    audience = RingnityPushAudience.CUSTOMER,
    externalId = "customer-123",
    appId = "com.example.customer"
)

ringnity.chat.sendMessage(
    conversationId = conversationId,
    body = "Hi, I need help."
)

ringnity.chat.subscribe(
    conversationId = conversationId
).collect { conversation ->
    println(conversation["messages"])
}

ringnity.chat.subscribeEvents(
    conversationId = conversationId
).collect { event ->
    println("${event.type}: ${event.data}")
}

ringnity.calls.subscribeEvents().collect { event ->
    println("${event.type}: ${event.data}")
}

val call = ringnity.calls.startVideo(
    conversationId = conversationId
)
ringnity.notifications.previewRingtone()
ringnity.notifications.stopRingtone()
call.mute()
call.setVideoEnabled(false)
call.end()

val existingCall = ringnity.calls.getSession(
    callSessionId = "call-session-id"
)

Ringtone behavior

// Add Android asset: app/src/main/res/raw/ringnity_default.*

ringnity.notifications.previewRingtone()

ringnity.notifications.playIncomingRingtone()

// Stop when the customer answers, declines, or the call expires.
ringnity.notifications.stopRingtone()