@sfmc/react-native-iam
v1.0.0
Published
In-App Messaging for the Salesforce Marketing Cloud Unified Mobile SDK
Readme
SFMC In-App Messaging
SFMC In-App Messaging Feature for React Native — SDK readiness and programmatic message display.
Installation
yarn add @sfmc/react-native-iam
# or
npm install @sfmc/react-native-iamiOS:
cd ios && pod installAndroid: no additional steps — Gradle autolinking discovers the module automatically.
Required SDK configuration
- Android — initialize in your
MainApplication.ktviaSFMCSdk.configure(...). See the Android SDK Integration Guide. - iOS — initialize in your
AppDelegate.swiftviaSFMCSdk.initializeSdk(...). See the iOS SDK Integration Guide.
Usage
import { IamModule } from '@sfmc/react-native-iam';
import type { IamApi } from '@sfmc/react-native-iam';
const iam: IamApi = await IamModule.requestSdk();
// Programmatically show an in-app message by ID
iam.showInAppMessage('message-id');API
| Method | Return | Description |
|--------|--------|-------------|
| showInAppMessage(messageId) | void | Programmatically display an in-app message by ID |
Notes
IAM lifecycle events (will show, did show, did close) are handled on the native side via InAppMessageEventDelegate (iOS) and InAppMessageManager.EventListener (Android), configured in your AppDelegate/Application class. The bridge module provides SDK readiness and programmatic message display only.
Versions
- React Native: 0.85.1 (New Architecture mandatory)
- Android: sfmcsdk 3.1.0, inappmessagingfeaturemodule 1.0.0
- iOS: SFInAppMessagingFeatureSDK 1.0.0, MarketingCloud-SFMCSdk 4.0.1
License
BSD 3-Clause. See LICENSE for details.
