SFMC MarketingCloud SDK (Engagement) #

Salesforce Marketing Cloud Engagement SDK for Flutter — inbox, registration, tags, attributes, analytics.

Installation #

flutter pub add sfmc_marketingcloudsdk

iOS:

cd ios && pod install

Android: no additional steps — Gradle resolves the dependency automatically.

Required SDK configuration #

• Android — initialize in your MainApplication.kt via SFMCSdk.configure(...). See the Android SDK Integration Guide.
• iOS — initialize in your AppDelegate.swift via SFMCSdk.initializeSdk(...). See the iOS SDK Integration Guide.
• Configure Firebase (Android) and APNs (iOS) credentials before push will deliver.

Location & proximity — config-time arming

The runtime toggles below (enableLocation(), enableProximityMessaging()) only work if the feature is armed at SDK-configuration time. Skipping this step means the runtime calls appear to succeed but no geofence transitions or beacon detections ever fire (the native SDK only logs a warning).

• Android — in MarketingCloudConfig.builder():

  .setGeofencingEnabled(true)        // required for enableLocation()
  .setProximityEnabled(true)         // required for enableProximityMessaging()
  .setProximityNotificationOptions(
      ProximityNotificationCustomizationOptions.create(iconResId),
  )
  

  Also declare ACCESS_FINE_LOCATION, ACCESS_BACKGROUND_LOCATION, BLUETOOTH_SCAN, and BLUETOOTH_CONNECT in AndroidManifest.xml, and request them at runtime.
• iOS — in MarketingCloudSdkConfigBuilder, call .setLocationEnabled(true). Add NSLocationWhenInUseUsageDescription, NSLocationAlwaysAndWhenInUseUsageDescription, and UIBackgroundModes → location to Info.plist. Proximity (beacon) messaging is Android-only.

Usage #

import 'package:sfmc_marketingcloudsdk/sfmc_marketingcloudsdk.dart';

// Initialize the MarketingCloudSdk module
await MarketingCloudSdk.requestSdk();

// Inbox
final refreshed = await MarketingCloudSdk.refreshInbox();
final allMsgs = await MarketingCloudSdk.getAllMessages();
final unreadCount = await MarketingCloudSdk.getUnreadMessageCount();
await MarketingCloudSdk.markMessageRead('message-id');

// Tags
await MarketingCloudSdk.addTag('beta-tester');
final tags = await MarketingCloudSdk.getTags();

// Device identity
final deviceId = await MarketingCloudSdk.getDeviceId();
final contactKey = await MarketingCloudSdk.getContactKey();

// Location & proximity
await MarketingCloudSdk.enableLocation();
await MarketingCloudSdk.startWatchingLocation(); // iOS only
final lastLocation = await MarketingCloudSdk.getLastKnownLocation();
await MarketingCloudSdk.enableProximityMessaging(); // Android only

// Registration callback
await MarketingCloudSdk.setRegistrationCallback();
MarketingCloudSdk.registrationEvents.listen((registration) {
  print('MC registration changed: $registration');
});

// Inbox response listener
await MarketingCloudSdk.registerInboxResponseListener((messages) {
  print('Inbox updated: ${messages.length} messages');
});

// Cleanup
await MarketingCloudSdk.unsetRegistrationCallback();

API #

Streams #

Notes #

Installing this package auto-resolves the shared sfmc_core foundation package. sfmc_push and sfmc_iam are independent, opt-in feature packages — add them explicitly with flutter pub add sfmc_push / flutter pub add sfmc_iam if you need push or in-app messaging.

Versions #

• Flutter: >=3.3.0
• Dart SDK: >=3.0.6 <4.0.0
• Android: sfmcsdk 3.1.+, marketingcloudsdk 11.0.+
• iOS: MarketingCloudSDK ~> 11.0.0

License #

BSD 3-Clause.