Status module

Purpose

Diagnostic: getStatus errors

If Affise.module.getStatus(...) returns an error or runs for more than two minutes, your credentials are likely invalid — re-check them via Validate credentials. Make sure the Status module itself is on the link line; without it getStatus returns no data.

Module constant

• AffiseModules.STATUS = "Status" (src/module/AffiseModules.ts:1-16)

TypeScript API

Affise.module.getStatus(module: AffiseModules, callback: OnKeyValueCallback): void
// src/module/attribution/AffiseModuleApi.ts:22

Callback types:

• OnKeyValueCallback = (value: AffiseKeyValue[]) => void (src/module/OnKeyValueCallback.ts:3)
• AffiseKeyValue { key: string; value: string } (src/module/AffiseKeyValue.ts:1-9)

Maps to AffiseApiMethod.GET_STATUS_CALLBACK = "get_status_callback" (src/native/AffiseApiMethod.ts:46).

Example

Affise.module.getStatus(AffiseModules.STATUS, (response) => {
    // response is AffiseKeyValue[]
});

Also required by

• Deferred deeplinks - Affise.getDeferredDeeplink requires the Status module.

Installation

Since 1.7.16 the module ships as its own npm package, affise-attribution-module-status (Android and iOS). Install it next to the core library:

npm install affise-attribution-lib
npm install affise-attribution-module-status

The package only pulls in the native dependency (com.affise:module-status / AffiseModule/Status at 1.7.16); its JS entry point is empty, so keep importing everything from affise-attribution-lib. Rebuild the native app (and run pod install on iOS) after installing.

Platform notes

Manual native alternative

The pod / implementation snippets below are the README’s “Modules → Manual Native” alternative to the npm package above.

iOS

pod 'AffiseModule/Status', '1.7.16'

Android

implementation "com.affise:module-status:$affise_version"