Status module

Installation

Artifact: com.affise:module-status (module-status/build.gradle:50).

implementation("com.affise:module-status:1.7.8")

Purpose

Fetches module statuses and is also required for Affise.getDeferredDeeplink / Affise.getDeferredDeeplinkValue.

API

Entry class: class StatusModule : AffiseModule(), ReferrerCallback (module-status/src/main/java/com/affise/attribution/module/status/StatusModule.kt:20).

Public entry on Affise.Module:

• Affise.Module.getStatus(module: AffiseModules, onComplete: OnKeyValueCallback) — attribution/src/main/java/com/affise/attribution/modules/attribution/AffiseAttributionModule.kt:29-31 (AffiseAttributionModuleApi.getStatus at attribution/src/main/java/com/affise/attribution/modules/attribution/AffiseAttributionModuleApi.kt:10)

Callback types:

• fun interface OnKeyValueCallback { fun handle(data: List<AffiseKeyValue>) } (attribution/src/main/java/com/affise/attribution/modules/OnKeyValueCallback.kt:3-6)
• data class AffiseKeyValue(val key: String, val value: String?) (attribution/src/main/java/com/affise/attribution/modules/AffiseKeyValue.kt:3-6)

The module also implements ReferrerCallback.getReferrer(callback: OnReferrerCallback) (StatusModule.kt:67-69).

Example

Status module must be installed

Affise.Module.getStatus(...) requires com.affise:module-status to be on the classpath. Without it the call returns no data. If getStatus errors out or runs for more than two minutes, your credentials are likely invalid — verify them via Validate credentials.

Kotlin

Affise.Module.getStatus(AffiseModules.Status) { response ->
  // handle response
}

Java

Affise.Module.getStatus(AffiseModules.Status, response -> {
    // handle response
});

Additional dependencies

None. No additional AndroidManifest.xml entries.

ProviderType values contributed

None (the module contributes status data, not identifiers).

Related: Deep linking — deferred deeplink.