Flutter

dependencies:
  shield_consent: ^1.0.0-beta.2

dependencies:
  shield_consent:
    git:
      url: https://github.com/DPDPA-Shield/flutter-plugin
      ref: main

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

import 'package:shield_consent/shield_consent.dart';

// 1. Initialise once, before runApp() or in main()
await ShieldConsent.init(apiKey: 'dpdpa_live_YOUR_KEY', cmpId: 1);

// 2. Load the published notice
final notice = await ShieldConsent.loadNotice();

// 3. Localise for the device language
final localized = ShieldConsent.localize(notice, languageCode: 'HI');

// 4. Show your consent UI using localized.title, localized.purposes, etc.
// ...

// 5. Record the user's decision
await ShieldConsent.recordDecision(
  ConsentDecision(
    noticeId: notice.id,
    given: {'analytics-purpose-id': true, 'marketing-purpose-id': false},
    languageShown: 'HI',
    decidedAtEpochMs: DateTime.now().millisecondsSinceEpoch,
  ),
  identifier: 'user@example.com', // hashed on-device before leaving the app
  languageShown: 'HI',
  externalId: 'user.id',          // optional - YOUR OWN user ID, sent as-is (never hashed)
);

final notice = await ShieldConsent.loadNotice();

// Use the device locale
final langCode = Platform.localeName.split('_').first.toUpperCase(); // e.g. "HI"
final localized = ShieldConsent.localize(notice, languageCode: langCode);

// localized.title          - translated, or English fallback
// localized.purposes       - each purpose with translated name/description
// localized.languageCode   - normalised uppercase code used

// One-shot check
if (await ShieldGate.isConsented('analytics')) {
  initAnalytics();
}

// Run a block only if consented (returns true if the block ran)
final ran = await ShieldGate.runIfConsented('marketing', () async {
  await FacebookAds.initialize();
});

// Reactive stream: fires immediately with the current state, then on every change
ShieldGate.observeConsented('analytics').listen((given) {
  FirebaseAnalytics.instance.setAnalyticsCollectionEnabled(given);
});

// Call flushQueue() when connectivity returns or the app resumes
import 'package:connectivity_plus/connectivity_plus.dart';

Connectivity().onConnectivityChanged.listen((result) {
  if (result != ConnectivityResult.none) {
    ShieldConsent.flushQueue();
  }
});

@override
void didChangeAppLifecycleState(AppLifecycleState state) {
  if (state == AppLifecycleState.resumed) {
    ShieldConsent.flushQueue();
  }
}