Flutter SDK

Overview

The Avafli Engagement SDK lets you add daily-entry sweepstakes and prize experiences to your app with a single configuration call. The SDK automatically opens the experience on the first app-open of each day, captures the user, and claims their daily entries — no scheduling or session logic on your side. You customize your logo, prize image, and brand color from the Avafli dashboard; everything else is managed server-side.

Requirements

Installation

Add to pubspec.yaml

Add the dependency to your pubspec.yaml:

dependencies:
  avafli_sdk: ^3.0.0

Then install the package:

flutter pub get

Quick Start

One call at app launch is the entire integration:

import 'package:avafli_sdk/avafli_sdk.dart';

await Avafli.configure(AvafliConfiguration(
  apiKey: 'YOUR_API_KEY', // debug builds: use your avafli_test_ sandbox key
  bundleId: 'com.example.myapp',
  user: AvafliUser(
    id: 'user_123',             // only id is required — pass whatever identity you have
    firstName: 'Jane',
    lastName: 'Doe',
    email: 'jane@example.com',  // include it when you have it — pre-fills & locks the capture form
  ),
  // Nobody signed in? use user: AvafliUser.guest
  options: AvafliOptions(
    logging: LoggingLevel.error,  // LoggingLevel.debug while integrating
    enablePushReminders: true,    // then forward tokens: Avafli.registerPushToken(token)
  ),
));

// Attach the navigator key: MaterialApp(navigatorKey: Avafli.navigatorKey, ...)
// Splash that clears the nav stack? holdAutoOpen() before configure, releaseAutoOpen() after.

Attach the SDK’s navigator key — MaterialApp(navigatorKey: Avafli.navigatorKey) — and the experience opens itself on the first app-open of each day. There is no manual launch API; presentation timing, the daily cadence, and dismissal are fully managed by the SDK. If your app boots through a splash screen or auth gate that ends by clearing the navigation stack (Get.offAll, pushAndRemoveUntil), call Avafli.holdAutoOpen() before configuring and Avafli.releaseAutoOpen() once your main screen is mounted, so the drawer isn’t destroyed by your boot navigation.

Push Notifications

Drive re-engagement with daily reminders. Forward your FCM token to the SDK:

import 'package:firebase_messaging/firebase_messaging.dart';

// Get the FCM token and forward it to Avafli
final fcmToken = await FirebaseMessaging.instance.getToken();
if (fcmToken != null) {
  await AvafliPushNotificationManager.instance.didReceiveRegistrationToken(fcmToken);
}

// Listen for token refreshes
FirebaseMessaging.instance.onTokenRefresh.listen((token) {
  AvafliPushNotificationManager.instance.didReceiveRegistrationToken(token);
});

Upload your FCM service account key via the Avafli Dashboard to enable push notifications.

Branding

Branding is configured server-side — no code changes needed. Publishers customize three things — their logo, the prize image, and their primary brand color — via the Customize Experience section in the publisher dashboard. Everything else is designed and managed by Avafli. Changes take effect immediately in the SDK.

Analytics

Connect your analytics system to track user engagement:

class MyAnalyticsAdapter implements AnalyticsAdapter {
  @override
  void trackEvent(String name, Map<String, dynamic> properties) {
    // Forward to Segment, Amplitude, Mixpanel, etc.
    analytics.track(name, properties);
  }
}

// Pass during configuration
await Avafli.configure(AvafliConfiguration(
  // ... other config
  options: AvafliOptions(
    analyticsAdapter: MyAnalyticsAdapter(),
  ),
));

GDPR Compliance

Handle erasure requests with a single method call. It removes the person's personal information everywhere it is held, covers all their devices, and keeps the experience silenced through a reinstall:

// Erase the user's personal data (Right-to-be-Forgotten)
await Avafli.optOut();

SDK Features