Marketing Cloud Mobile App Messaging SDK

This section provides API reference details for the Marketing Cloud Next (Mobile App Messaging) SDK module in the Flutter unified plugin.

getDeviceId

Returns the device ID that Marketing Cloud Next uses to identify the device.

Syntax

MobileAppMessaging.getDeviceId();

Returns

• Future<String?> - A future that resolves with the device ID, or null.

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
final deviceId = await MobileAppMessaging.getDeviceId();

See Also

• Android SDK Reference
• iOS SDK Reference

enableAnalytics

Enables analytics for Marketing Cloud Next.

Syntax

MobileAppMessaging.enableAnalytics();

Returns

• Future<void>

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
await MobileAppMessaging.enableAnalytics();

See Also

• Android SDK Reference
• iOS SDK Reference

disableAnalytics

Disables analytics for Marketing Cloud Next.

Syntax

MobileAppMessaging.disableAnalytics();

Returns

• Future<void>

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
await MobileAppMessaging.disableAnalytics();

See Also

• Android SDK Reference
• iOS SDK Reference

isAnalyticsEnabled

Checks whether analytics is enabled for Marketing Cloud Next.

Syntax

MobileAppMessaging.isAnalyticsEnabled();

Returns

• Future<bool> - A future that resolves with whether analytics is enabled.

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
final enabled = await MobileAppMessaging.isAnalyticsEnabled();

See Also

• Android SDK Reference
• iOS SDK Reference

setRegistrationCallback

Registers a callback to receive registration change events from the SDK.

Syntax

MobileAppMessaging.setRegistrationCallback();

Returns

• Future<void>

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
await MobileAppMessaging.setRegistrationCallback();

See Also

• Android SDK Reference
• iOS SDK Reference

unsetRegistrationCallback

Unregisters the registration change callback.

Syntax

MobileAppMessaging.unsetRegistrationCallback();

Returns

• Future<void>

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
await MobileAppMessaging.unsetRegistrationCallback();

See Also

• Android SDK Reference
• iOS SDK Reference

registrationEvents

A broadcast stream of registration events. Emits a map of registration data when the registration changes.

Syntax

MobileAppMessaging.registrationEvents;

Returns

• Stream<Map<String, dynamic>> - A broadcast stream that emits a map of registration data on every registration change.

Example

import 'package:sfmc_mobileappmessaging/sfmc_mobileappmessaging.dart';

await MobileAppMessaging.requestSdk();
MobileAppMessaging.registrationEvents.listen((event) {
  print('Registration changed: $event');
});