digia_engage 1.0.0-beta.2

digia_engage: ^1.0.0-beta.2 copied to clipboard

Digia Engage is the Flutter SDK for displaying in-app campaigns powered by Digia Studio. It connects to your Customer Engagement Platform (MoEngage, CleverTap, etc.) and renders server-driven in-app experiences — dialogs, bottom sheets, and inline widgets — without shipping a new app build.

How It Works #

1. Your CEP (e.g. MoEngage) sends a campaign trigger to the device.
2. The DigiaCEPPlugin adapter receives the payload and hands it to the SDK.
3. The SDK routes it to the right renderer:
   • Modal (dialog / bottom sheet) → rendered by DigiaHost
   • Inline (banner / card) → rendered by DigiaSlot
4. The component is built from a server-driven layout defined in Digia Studio — no client-side code changes needed.

Installation #

dependencies:
  digia_engage: 1.0.0-beta.1

Quick Start #

1. Initialize #

Call once in main() before runApp().

await Digia.initialize(
  DigiaConfig(
    apiKey: 'YOUR_API_KEY',
    flavor: Flavor.release(),
    strategy: NetworkFirstStrategy(timeoutInMs: 2000),
  ),
);

2. Register your CEP plugin #

After your CEP SDK is ready, register its adapter:

Digia.register(MoEngagePlugin(instance: moEngageInstance));

3. Add DigiaHost and DigiaNavigatorObserver #

Wrap your MaterialApp so the SDK can show modal overlays and track screens:

MaterialApp(
  navigatorKey: DigiaHost.navigatorKey,
  navigatorObservers: [DigiaNavigatorObserver()],
  builder: (context, child) => DigiaHost(child: child!),
  home: const MyHomePage(),
)

navigatorKey: DigiaHost.navigatorKey is required. DigiaHost sits in MaterialApp.builder which is above the Navigator in the widget tree. Without this key the SDK cannot resolve a navigator context to show modals.

4. Add DigiaSlot where inline content should appear #

Place a slot anywhere in your page layout. Use the same placement key that was configured in Digia Studio.

Column(
  children: [
    DigiaSlot('home_hero_banner'),
    // ... rest of your page
  ],
)

API Reference #

Digia #

Static facade — the single entry point for all SDK calls.

DigiaConfig #

DigiaHost #

Mount once in MaterialApp.builder. Automatically renders modal campaigns (dialog / bottom sheet) when triggered by the CEP.

MaterialApp(
  navigatorKey: DigiaHost.navigatorKey,   // required
  navigatorObservers: [DigiaNavigatorObserver()],
  builder: (context, child) => DigiaHost(child: child!),
)

Behavior:

DigiaSlot #

Renders inline campaign content at a named placement position. Collapses to nothing when no campaign is active.

DigiaSlot('placement_key')

Lifecycle:

DigiaNavigatorObserver #

Automatically reports the current route name to the CEP as a screen-change event. Add it to navigatorObservers and no manual setCurrentScreen calls are needed.

navigatorObservers: [DigiaNavigatorObserver()]

CEP Plugin Interface #

To connect a new CEP, implement DigiaCEPPlugin:

class MyCEPPlugin implements DigiaCEPPlugin {
  @override
  String get identifier => 'my_cep';

  @override
  void setup(DigiaCEPDelegate delegate) {
    // Subscribe to in-app events from your CEP SDK and pass payloads
    // to delegate.onExperienceReady(payload)
  }

  @override
  void teardown() { /* clean up subscriptions */ }

  @override
  void notifyEvent(DigiaExperienceEvent event, InAppPayload payload) {
    // Forward impression/dismiss events back to your CEP
  }

  @override
  void forwardScreen(String screenName) {
    // Forward screen name to your CEP
  }
}

Then register it:

Digia.register(MyCEPPlugin());

Experience Events #

The SDK fires two events during a campaign lifecycle, forwarded to your CEP plugin via notifyEvent:

License #

This project is licensed under the Business Source License 1.1 (BSL 1.1) - see the LICENSE file for details. The BSL 1.1 allows personal and commercial use with certain restrictions around competing platforms. On August 5, 2029, the license will automatically convert to Apache License 2.0.

For commercial licensing inquiries or exceptions, please contact admin@digia.tech.

Support #

• 📚 Documentation
• 📧 Contact Support