Marketing Cloud Mobile App Messaging SDK

This section provides API reference details for the Marketing Cloud Mobile App Messaging SDK module in React Native unified plugin.

getDeviceId 

Returns the device ID that Mobile App Messaging uses to identify the device.

Syntax 

1MobileAppMessagingSdkModule.getDeviceId();

Returns 

  • Promise<string \| null> - A promise that resolves to the device ID, or null.

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5const deviceId = await mam.getDeviceId();

See Also 

enableAnalytics 

Enables analytics in the Mobile App Messaging SDK.

Syntax 

1MobileAppMessagingSdkModule.enableAnalytics();

Returns 

  • void

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5mam.enableAnalytics();

See Also 

disableAnalytics 

Disables analytics in the Mobile App Messaging SDK.

Syntax 

1MobileAppMessagingSdkModule.disableAnalytics();

Returns 

  • void

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5mam.disableAnalytics();

See Also 

isAnalyticsEnabled 

Checks whether analytics is enabled in the Mobile App Messaging SDK.

Syntax 

1MobileAppMessagingSdkModule.isAnalyticsEnabled();

Returns 

  • Promise<boolean> - A promise that resolves to whether analytics is enabled.

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5const enabled = await mam.isAnalyticsEnabled();

See Also 

setRegistrationCallback 

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

Syntax 

1MobileAppMessagingSdkModule.setRegistrationCallback();

Returns 

  • void

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5mam.setRegistrationCallback();
6
7const sub = MobileAppMessagingModule.getEmitter().addListener(
8  "sfmc_mam_registration",
9  (registration) => {
10    console.log("MAM registration changed:", registration);
11  },
12);
13
14sub.remove();

See Also 

unsetRegistrationCallback 

Unregisters the registration change callback.

Syntax 

1MobileAppMessagingSdkModule.unsetRegistrationCallback();

Returns 

  • void

Example 

1import { MobileAppMessagingModule } from "@sfmc/react-native-mobileappmessaging";
2import type { MAMApi } from "@sfmc/react-native-mobileappmessaging";
3
4const mam: MAMApi = await MobileAppMessagingModule.requestSdk();
5mam.unsetRegistrationCallback();

See Also