Deep linking

The Affise SDK exposes a single callback API — Affise.registerDeeplinkCallback — for both custom-scheme deeplinks and HTTPS AppLinks.

API

• Affise.registerDeeplinkCallback(callback: OnDeeplinkCallback) (attribution/src/main/java/com/affise/attribution/Affise.kt:71-74)
• fun interface OnDeeplinkCallback { fun handleDeeplink(value: DeeplinkValue) } (attribution/src/main/java/com/affise/attribution/deeplink/OnDeeplinkCallback.kt:7-12)
• data class DeeplinkValue(deeplink: String, scheme: String?, host: String?, path: String?, parameters: Map<String, List<String>>) (attribution/src/main/java/com/affise/attribution/deeplink/DeeplinkValue.kt:5-11)

Deeplinks (custom scheme)

Caution

Deeplinks support only CUSTOM scheme — NOT http or https. For https links use AppLinks below.

Declare an intent filter with your custom scheme in AndroidManifest.xml, then register the callback during or after SDK initialization.

Kotlin

Affise.settings(affiseAppId, secretKey).start(context) // Start Affise SDK

Affise.registerDeeplinkCallback { value ->
    // full uri "scheme://host/path?parameters"
    val deeplink = value.deeplink

    // separated for convenience
    val scheme = value.scheme
    val host = value.host
    val path = value.path
    val queryParametersMap = value.parameters

    if(queryParametersMap["<your_uri_key>"].contains("<your_uri_key_value>")) {
        // handle value
    }
}

Java

Affise.registerDeeplinkCallback(value -> {
    // full uri "scheme://host/path?parameters"
    String deeplink = value.getDeeplink();

    // separated for convenience
    String scheme = value.getScheme();
    String host = value.getHost();
    String path = value.getPath();
    Map<String, List<String>> queryParametersMap = value.getParameters();

    if (queryParametersMap.get("your_uri_key").contains("your_uri_key_value")) {
        // handle value
    }
});

DeeplinkValue fields

| Field | Type | |---|---| | deeplink | String | | scheme | String? | | host | String? | | path | String? | | parameters | Map<String, List<String>> |

AppLinks

The SDK uses the same Affise.registerDeeplinkCallback(...) API for HTTPS AppLinks. Unlike custom-scheme deeplinks, AppLinks require:

• an intent filter with http/https scheme and android:autoVerify="true"
• an assetlinks.json served at https://yoursite/.well-known/assetlinks.json

You must own the domain

AppLinks only work if you control a domain you can publish files on. The Digital Asset Links file at https://yoursite/.well-known/assetlinks.json must be reachable over HTTPS — HTTP-only hosting will not satisfy Android’s verifier.

Get deferred deeplink

Requires the Status module.

• Affise.getDeferredDeeplink(callback: OnReferrerCallback?) (Affise.kt:186-189)
• fun interface OnReferrerCallback { fun handleReferrer(value: String?) } (attribution/src/main/java/com/affise/attribution/referrer/OnReferrerCallback.kt:7-12)

Affise.getDeferredDeeplink { deferredDeeplink ->
  // handle deferred deeplink
}

Get deferred deeplink value

Affise.getDeferredDeeplinkValue(key: ReferrerKey, callback: OnReferrerCallback?) (Affise.kt:194-197). Requires the Status module. For the full list of ReferrerKey values see Referrer.

Affise.getDeferredDeeplinkValue(ReferrerKey.CLICK_ID) { deferredDeeplinkValue ->
  // handle deferred deeplink value
}

Testing via adb

You can trigger deeplinks from a terminal using adb:

adb shell am start -a android.intent.action.VIEW -d "scheme://host/path?key=value" <your.package.name>