Popin Android SDK v2 – Integration Documentation

A video calling SDK for Android that enables seamless video communication with queue management, scheduling, and real-time notifications.

---

Requirements

• Min SDK: 24 (Android 7.0)

• Target SDK: 35 (Android 15)

• Java: 17

---

Integration Options

Feature	Standard (AAR)	Dynamic Feature Module (DFM)
Install size	SDK bundled at install time	SDK downloaded on demand
Distribution	JitPack or local AAR	Play Store only
API surface	Popin.* directly	PopinLoader.*
Incoming calls	Works immediately	Requires DFM to be installed first
Complexity	Low	Medium

Choose Standard if:

• You distribute outside the Play Store

• You want the simplest integration

Choose DFM if:

• You distribute via Play Store

• You want to reduce install size

---

Option A — Standard Integration (AAR / JitPack)

Step 1 — Add JitPack Repository

settings.gradle.kts

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url = uri("https://jitpack.io")
            credentials { username = "YOUR_JITPACK_TOKEN" }
        }
    }
}

settings.gradle (Groovy)

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven {
            url 'https://jitpack.io'
            credentials { username authToken }
        }
    }
}

Store token securely in local.properties

authToken=YOUR_JITPACK_TOKEN

Load token in root build.gradle

Properties localProps = new Properties()
localProps.load(new FileInputStream(rootProject.file("local.properties")))
ext.authToken = localProps['authToken'] ?: ""

---

Step 2 — Add Dependency

dependencies {
    implementation 'com.github.Springr-Creatives.PopinAndroidSDK:PopinCustomerSDK:Tag'
}

Replace Tag with the latest release version (e.g., 2.0.41).

---

Step 3 — Configure AndroidManifest.xml

<application ...>
    <meta-data
        android:name="to.popin.androidsdk.POPIN_TOKEN"
        android:value="YOUR_ACCESS_TOKEN" />
</application>

---

Step 4 — Initialize SDK

PopinConfig config = new PopinConfig.Builder()
    .userName("John Doe")
    .contactInfo("9876543210")
    .sandboxMode(true)
    .initListener(new PopinInitListener() {
        @Override
        public void onInitComplete(int userId) {
            Log.d("Popin", "Ready, userId=" + userId);
        }

        @Override
        public void onInitFailed(String reason) {
            Log.e("Popin", "Init failed: " + reason);
        }
    })
    .build();

Popin.init(this, config);

---

Option B — Dynamic Feature Module (DFM)

⚠️ Requirement: Your app must be distributed via Google Play. Sideloaded APKs do not support Play Feature Delivery.

---

Project Structure

:app
:customer-api
:customer
:customer_dfm
:common

---

Step 1 — Include DFM Module

settings.gradle

include ':customer_dfm'

Add JitPack repository (same as Standard integration).

---

Step 2 — customer_dfm/build.gradle

plugins {
    id 'com.android.dynamic-feature'
}

android {
    namespace 'to.popin.androidsdk.dfm'
    compileSdk 35

    defaultConfig {
        minSdk 24
    }

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_17
        targetCompatibility JavaVersion.VERSION_17
    }
}

dependencies {
    implementation project(':app')
    implementation 'com.github.Springr-Creatives.PopinAndroidSDK:PopinCustomerSDK:Tag'
}

---

customer_dfm AndroidManifest.xml

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:dist="http://schemas.android.com/apk/distribution">

    <dist:module
        dist:instant="false"
        dist:title="@string/title_customer_dfm">

        <dist:delivery>
            <dist:on-demand />
        </dist:delivery>

        <dist:fusing dist:include="true" />
    </dist:module>
</manifest>

---

Step 3 — app/build.gradle

android {
    dynamicFeatures = [':customer_dfm']
}

dependencies {
    implementation 'com.github.Springr-Creatives.PopinAndroidSDK:PopinCustomerApiSDK:Tag'
    implementation 'com.github.Springr-Creatives.PopinAndroidSDK:PopinCommonSDK:Tag'

    implementation 'com.google.android.play:feature-delivery:2.1.0'

    debugImplementation 'com.github.chuckerteam.chucker:library:4.0.0'
    releaseImplementation 'com.github.chuckerteam.chucker:library-no-op:4.0.0'
    implementation 'com.karumi:dexter:6.2.3'
}

---

Step 4 — Initialize with SplitInstallManager

SplitInstallManager splitInstallManager =
    SplitInstallManagerFactory.create(this);

if (splitInstallManager.getInstalledModules()
        .contains("customer_dfm")) {
    initPopin();
} else {
    SplitInstallRequest request =
        SplitInstallRequest.newBuilder()
            .addModule("customer_dfm")
            .build();

    splitInstallManager.startInstall(request)
        .addOnSuccessListener(sessionId -> initPopin())
        .addOnFailureListener(e -> Log.e("DFM", "Install failed", e));
}

---

DFM API Differences

Standard	DFM
Popin.init()	PopinLoader.init()
Popin.getInstance()	PopinLoader.getInstance()
Popin.deinit()	PopinLoader.deinit()

---

Setup

Add this inside <application>:

<meta-data
    android:name="to.popin.androidsdk.POPIN_TOKEN"
    android:value="YOUR_ACCESS_TOKEN" />

💡 The SDK manages runtime permissions automatically.

---

Initialization

Initialize in Application class (required for FCM):

public class MyApplication extends Application {

    @Override
    public void onCreate() {
        super.onCreate();

        PopinConfig config = new PopinConfig.Builder()
            .userName("User Name")
            .contactInfo("9876543210")
            .enableIncomingCalls(true)
            .build();

        Popin.init(this, config);
    }
}

Register in Manifest:

<application
    android:name=".MyApplication"
    ... >

---

Starting a Call

Popin.getInstance().startCall(new PopinEventsListener() {

    @Override
    public void onCallStart() {}

    @Override
    public void onCallConnected() {}

    @Override
    public void onCallEnd() {}
});

---

Scheduling

Get Available Slots

Popin.getInstance().getAvailableScheduleSlots(
    new PopinScheduleListener() {
        @Override
        public void onAvailableScheduleLoaded(List<ScheduleSlot> slots) {}

        @Override
        public void onScheduleLoadError() {}
});

Create Schedule

Popin.getInstance().createSchedule(
    "2024-01-15T10:00:00Z",
    new PopinCreateScheduleListener() {
        @Override
        public void onScheduleCreated() {}

        @Override
        public void onScheduleLoadError() {}
});

---

Permissions

Automatically requested:

• INTERNET

• CAMERA

• RECORD_AUDIO

• MODIFY_AUDIO_SETTINGS

• ACCESS_NETWORK_STATE

• BLUETOOTH_CONNECT

---

Proguard

Standard integration requires no manual rules.

For DFM (if needed):

-keep class to.popin.androidsdk.** { *; }
-keep class to.popin.common.** { *; }

---

Environment

Production

.sandboxMode(false)

Sandbox

.sandboxMode(true)

---

Testing DFM Locally

./gradlew :app:assembleDebug

adb install-multiple \
  app/build/outputs/apk/debug/app-debug.apk \
  customer_dfm/build/outputs/apk/debug/customer_dfm-debug.apk