Android SDK

​

How Android Push Works

1. Your app installs the Sendrealm Android SDK.
2. Firebase Cloud Messaging gives the app a device token.
3. Sendrealm stores that token and uses Firebase Cloud Messaging to deliver notifications later.

​

Setup Order

1. Create or select your Sendrealm app in the dashboard.
2. Configure Android Firebase credentials in Sendrealm.
3. Install the Android SDK in your app.
4. Initialize the SDK once during app startup.
5. Request notification permission after your app explains the value.
6. Link the device with login after user sign-in.
7. Send a test notification from Sendrealm.

​

Requirements

• Android API 27 or newer
• Kotlin or Java Android app
• Google Play services on the test device or emulator
• A Sendrealm app ID from the dashboard
• Firebase Cloud Messaging configured for the same Android package name
• google-services.json added to your Android app
• Firebase service account JSON uploaded to the Sendrealm dashboard

​

Firebase Files You Need

​

Generate google-services.json

1. Open the Firebase console.
2. Select the Firebase project for your Android app.
3. If you only have a Google Cloud project, choose Add Firebase to Google Cloud project in the Firebase console, select the existing Google Cloud project, and complete the Firebase setup.
4. In the Firebase project overview, click the Android icon or Add app.
5. Enter the exact Android package name from your app, usually the applicationId in your app-level Gradle file.
6. Click Register app.
7. Click Download google-services.json.
8. Move the file into your Android app module root:

app/google-services.json

​

Configure The Google Services Gradle Plugin

plugins {
    id("com.google.gms.google-services") version "4.5.0" apply false
}

plugins {
    id("com.android.application")
    id("com.google.gms.google-services")
}

​

Install

dependencies {
    implementation("com.sendrealm:sendrealm-android:<version>")
}

dependencies {
    implementation(project(":sendrealm-android"))
}

• android.permission.INTERNET
• android.permission.POST_NOTIFICATIONS
• A Firebase messaging service
• A notification action receiver

​

Initialize

import android.os.Bundle
import android.util.Log
import androidx.activity.ComponentActivity
import com.sendrealm.sdk.Sendrealm
import com.sendrealm.sdk.SendrealmConfig

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val config = SendrealmConfig()
            .setAutoRequestPermission(false)

        Sendrealm.initialize(
            context = this,
            appId = "YOUR_SENDREALM_APP_ID",
            config = config
        ) { token ->
            if (token != null) {
                Log.d("Push", "Registered FCM token: $token")
            } else {
                Log.w("Push", "Sendrealm initialized, but token registration failed")
            }
        }
    }
}

• Stores your Sendrealm app ID.
• Creates or restores the local Sendrealm device ID.
• Calls the Sendrealm SDK API initialization endpoint.
• Receives Firebase provider configuration from Sendrealm.
• Initializes Firebase when the host app has not already done so.
• Gets the Firebase Cloud Messaging token.
• Registers the token with Sendrealm.
• Starts lifecycle tracking for foreground and background behavior.

​

Configuration Options

• setExternalUserId("user-123"): links the device to a user during initialization.
• setUserEmail("user@example.com"): links the device to an email during initialization.
• setPlatform("android"): platform value sent to Sendrealm. Android apps should use android.
• setAutoRequestPermission(false): controls whether initialization immediately requests notification permission.

​

Notification Permission

Sendrealm.requestPermission(this)

val allowed = Sendrealm.hasNotificationPermission(this)

1. Initialize Sendrealm.
2. Show an in-app explanation.
3. Call Sendrealm.requestPermission(activity).
4. Check Sendrealm.hasNotificationPermission(context).
5. If disabled, guide the user to Android notification settings.

​

Notification Opens And Deep Links

override fun onNewIntent(intent: Intent) {
    super.onNewIntent(intent)
    setIntent(intent)
    Sendrealm.handleNotificationOpen(intent)
}

• App deep links, such as myapp://orders/123
• Android App Links, such as https://example.com/orders/123
• External URLs, such as https://example.com

​

Identity

Sendrealm.login("user-123", "user@example.com")

Sendrealm.logout()

​

Tags

Sendrealm.addTags(
    mapOf(
        "plan" to "pro",
        "onboardingComplete" to true
    )
)

• plan = "pro"
• theme = "dark"
• onboardingComplete = true
• lastViewedCategory = "shoes"

​

Custom Events

Sendrealm.trackEvent(
    "checkout_started",
    mapOf(
        "product_id" to "sku_123",
        "price" to 29
    )
)

​

Notification Channels

• During initialization
• After token registration or refresh
• Periodically when the app resumes

• orders
• promotions
• account_alerts
• chat_messages

​

Delivery Timing And OS Behavior

• The device is in Doze or App Standby.
• The app is restricted by battery optimization or OEM background limits.
• The user disabled notifications for the app or channel.
• Android channel importance is too low.
• The device is offline or has poor network connectivity.
• Too many messages are pending for the device.
• A high-priority message does not result in a visible notification and FCM lowers future priority behavior.
• The app spends too long processing the message before displaying it.

​

Testing Checklist

• The app initializes without SDK errors.
• Diagnostics show a Sendrealm device ID.
• Diagnostics show a registration token is present.
• Notification permission is granted on Android 13 or newer.
• The Android package name in Firebase matches your app applicationId.
• The Firebase service account JSON is uploaded in Sendrealm.
• A test notification arrives while the app is foregrounded.
• A test notification arrives while the app is backgrounded.
• Time-sensitive notifications use an appropriate priority.
• Non-urgent notifications still make sense if they arrive later.
• Tapping the notification opens the expected screen or URL.

​

Diagnostics

val diagnostics = Sendrealm.getDiagnostics(this)
Log.d("Sendrealm", diagnostics.toString())

• deviceId: should be present after initialization.
• registrationTokenPresent: should be true after FCM token registration.
• permissionStatus: should be authorized when notifications are allowed.
• subscribed: should be true unless the user opted out.
• lastSdkError: should be empty or explain the latest failure.

​

Troubleshooting

​

Related Pages

• Mobile Push Credentials
• Send Push Notification API
• React Native Bare SDK