Android API Reference

This page provides a comprehensive reference for all public methods, properties, and types in the AppDNA Android SDK.

Core Methods

Methods available directly on the AppDNA object.

Method	Signature	Description
`configure`	`configure(context: Context, apiKey: String, environment: Environment, options: AppDNAOptions)`	Initialize the SDK. Call once in `Application.onCreate()`.
`identify`	`identify(userId: String, traits: Map<String, Any>?)`	Associate events with a user ID and optional traits.
`reset`	`reset()`	Clear user identity, generate new anonymous ID, and flush events.
`track`	`track(event: String, properties: Map<String, Any>?)`	Track a named event with optional properties.
`flush`	`flush()`	Force an immediate flush of all queued events.
`onReady`	`onReady(callback: () -> Unit)`	Register a callback for when the SDK is fully initialized.
`shutdown`	`shutdown()`	Gracefully shut down the SDK and release resources.
`setLogLevel`	`setLogLevel(level: String)`	Change log verbosity at runtime. Accepts `"none"`, `"error"`, `"warning"`, `"info"`, `"debug"`.
`setConsent`	`setConsent(analytics: Boolean)`	Enable or disable analytics data collection.

Config Methods

Method	Signature	Returns	Description
`getRemoteConfig`	`getRemoteConfig(key: String)`	`Any?`	Retrieve a remote configuration value by key.
`isFeatureEnabled`	`isFeatureEnabled(flag: String)`	`Boolean`	Check whether a feature flag is enabled.

Experiment Methods

Method	Signature	Returns	Description
`getExperimentVariant`	`getExperimentVariant(experimentId: String)`	`String?`	Get the assigned variant for an experiment.
`isInVariant`	`isInVariant(experimentId: String, variantId: String)`	`Boolean`	Check if the user is in a specific experiment variant.
`getExperimentConfig`	`getExperimentConfig(experimentId: String, key: String)`	`Any?`	Get a configuration value for a specific experiment.

Push Methods

Method	Signature	Description
`setPushToken`	`setPushToken(token: String)`	Register the FCM push token.
`onNewPushToken`	`onNewPushToken(token: String)`	Alternative method to register the FCM push token.
`setPushPermission`	`setPushPermission(granted: Boolean)`	Report push notification permission status.
`trackPushDelivered`	`trackPushDelivered(pushId: String)`	Track that a push notification was delivered.
`trackPushTapped`	`trackPushTapped(pushId: String, action: String?)`	Track that a push notification was tapped.

Presentation Methods

Method	Signature	Returns	Description
`presentOnboarding`	`presentOnboarding(activity: Activity, flowId: String?, listener: AppDNAOnboardingDelegate?)`	`Boolean`	Present an onboarding flow. Returns whether it was presented.
`presentPaywall`	`presentPaywall(activity: Activity, id: String, context: PaywallContext?, listener: AppDNAPaywallDelegate?)`	`Unit`	Present a paywall.

Web Entitlements

Member	Type	Description
`webEntitlement`	`WebEntitlement?` (property)	The current web entitlement, if any.
`onWebEntitlementChanged`	`(callback: (WebEntitlement?) -> Unit)`	Register a listener for web entitlement changes.

Deep Links

Method	Signature	Description
`checkDeferredDeepLink`	`checkDeferredDeepLink(callback: (DeferredDeepLink?) -> Unit)`	Check for a deferred deep link and invoke the callback with the result.

Module Namespaces

The SDK exposes the following module namespaces for direct access:

Namespace	Type	Description
`AppDNA.push`	`PushModule`	Push notification management
`AppDNA.billing`	`BillingModule`	Billing and subscription management
`AppDNA.onboarding`	`OnboardingModule`	Onboarding flow presentation
`AppDNA.paywall`	`PaywallModule`	Paywall presentation
`AppDNA.remoteConfig`	`RemoteConfigModule`	Remote configuration access
`AppDNA.features`	`FeaturesModule`	Feature flag access
`AppDNA.experiments`	`ExperimentsModule`	Experiment variant access
`AppDNA.inAppMessages`	`InAppMessagesModule`	In-app message management
`AppDNA.surveys`	`SurveysModule`	Survey management
`AppDNA.deepLinks`	`DeepLinksModule`	Deep link handling

Delegate Interfaces

AppDNAPushDelegate

interface AppDNAPushDelegate {
    fun onPushTokenRegistered(token: String)
    fun onPushReceived(notification: PushPayload, inForeground: Boolean)
    fun onPushTapped(notification: PushPayload, actionId: String?)
}

AppDNABillingDelegate

interface AppDNABillingDelegate {
    fun onPurchaseCompleted(productId: String, transaction: TransactionInfo)
    fun onPurchaseFailed(productId: String, error: Exception)
    fun onEntitlementsChanged(entitlements: List<Entitlement>)
    fun onRestoreCompleted(restoredProducts: List<String>)
}

AppDNAOnboardingDelegate

interface AppDNAOnboardingDelegate {
    fun onOnboardingStarted(flowId: String)
    fun onOnboardingStepChanged(flowId: String, stepId: String, stepIndex: Int, totalSteps: Int)
    fun onOnboardingCompleted(flowId: String, responses: Map<String, Any>)
    fun onOnboardingDismissed(flowId: String, atStep: Int)
}

AppDNAPaywallDelegate

interface AppDNAPaywallDelegate {
    fun onPaywallPresented(paywallId: String)
    fun onPaywallAction(paywallId: String, action: PaywallAction)
    fun onPaywallPurchaseStarted(paywallId: String, productId: String)
    fun onPaywallPurchaseCompleted(paywallId: String, productId: String, transaction: TransactionInfo)
    fun onPaywallPurchaseFailed(paywallId: String, error: Exception)
    fun onPaywallDismissed(paywallId: String)
}

Types

AppDNAOptions

data class AppDNAOptions(
    val flushInterval: Long = 30L,
    val batchSize: Int = 20,
    val configTTL: Long = 300L,
    val logLevel: LogLevel = LogLevel.WARNING
)

Environment

enum class Environment(val baseUrl: String) {
    PRODUCTION("https://api.appdna.ai"),
    SANDBOX("https://sandbox-api.appdna.ai")
}

LogLevel

enum class LogLevel(val value: Int) {
    NONE(0),
    ERROR(1),
    WARNING(2),
    INFO(3),
    DEBUG(4)
}

PaywallContext

data class PaywallContext(
    val placement: String,
    val experiment: String? = null,
    val variant: String? = null
)

OnboardingContext

data class OnboardingContext(
    val source: String? = null,
    val campaign: String? = null,
    val referrer: String? = null,
    val userProperties: Map<String, Any>? = null,
    val experimentOverrides: Map<String, String>? = null
)

PushPayload

data class PushPayload(
    val pushId: String,
    val title: String,
    val body: String,
    val imageUrl: String? = null,
    val data: Map<String, Any>? = null,
    val action: PushAction? = null
)

PushAction

data class PushAction(
    val type: String,
    val value: String
)

TransactionInfo

data class TransactionInfo(
    val transactionId: String,
    val productId: String,
    val purchaseDate: String,
    val environment: String
)

Entitlement

data class Entitlement(
    val productId: String,
    val store: String,
    val status: String,
    val expiresAt: String? = null,
    val isTrial: Boolean,
    val offerType: String? = null
)

ProductInfo

data class ProductInfo(
    val id: String,
    val name: String,
    val description: String,
    val formattedPrice: String,
    val priceMicros: Long,
    val currencyCode: String,
    val offerToken: String? = null
)

PurchaseResult

sealed class PurchaseResult {
    data class Purchased(val entitlement: Entitlement) : PurchaseResult()
    object Cancelled : PurchaseResult()
    object Pending : PurchaseResult()
    object Unknown : PurchaseResult()
    data class Failed(val error: Exception) : PurchaseResult()
}

PaywallAction

enum class PaywallAction {
    CTA_TAPPED,
    FEATURE_SELECTED,
    PLAN_CHANGED,
    LINK_TAPPED,
    CUSTOM
}

DismissReason

enum class DismissReason {
    PURCHASED,
    DISMISSED,
    TAPPED_OUTSIDE,
    PROGRAMMATIC
}

WebEntitlement

data class WebEntitlement(
    val productId: String,
    val status: String,
    val expiresAt: String?,
    val source: String
)

DeferredDeepLink

data class DeferredDeepLink(
    val url: String,
    val campaign: String?,
    val medium: String?,
    val source: String?
)

SDKs

​Core Methods

​Config Methods

​Experiment Methods

​Push Methods

​Presentation Methods

​Web Entitlements

​Deep Links

​Module Namespaces

​Delegate Interfaces

​AppDNAPushDelegate

​AppDNABillingDelegate

​AppDNAOnboardingDelegate

​AppDNAPaywallDelegate

​Types

​AppDNAOptions

​Environment

​LogLevel

​PaywallContext

​OnboardingContext

​PushPayload

​PushAction

​TransactionInfo

​Entitlement

​ProductInfo

​PurchaseResult

​PaywallAction

​DismissReason

​WebEntitlement

​DeferredDeepLink