Skip to content

Privacy

Affise.setTrackingEnabled(enabled: boolean)
// src/index.ts:127-129
Affise.isTrackingEnabled(): Promise<boolean>
// src/index.ts:134-136

Behaviour (JSDoc, src/index.ts:122-126):

When disabled, library should not generate any tracking events

README notes:

By default, tracking is enabled. / Keep in mind that this flag is persistent until app reinstall

Affise.setBackgroundTrackingEnabled(enabled: boolean)
// src/index.ts:111-113
Affise.isBackgroundTrackingEnabled(): Promise<boolean>
// src/index.ts:118-120

Behaviour (JSDoc, src/index.ts:106-110):

When disabled, library should not generate any tracking events while in background

README notes:

By default, background tracking is enabled. / Background tracking mode is persistent as Application lifecycle, and will be re-enabled with process termination automatically.

Affise.android.forget(userData: string): void
// src/module/attribution/AffiseAndroid.ts:16-19
// interface: src/module/attribution/AffiseAndroidApi.ts:5

Erases all user data from the device and sends a GDPREvent. The API is gated to Android via Platform.OS — calling it from iOS has no effect. Always pass the required userData string argument.

Affise.android.crashApplication(): void (src/module/attribution/AffiseAndroid.ts:21-24, interface AffiseAndroidApi.ts:7) forces a native crash for testing; maps to AffiseApiMethod.CRASH_APPLICATION = "crash_application" (src/native/AffiseApiMethod.ts:20).