Content Card integration

This article covers how to set up Content Cards for your Flutter app.

The Braze SDK includes a default card feed to get you started with Content Cards. To show the card feed, you can use the braze.launchContentCards() method. The default card feed included with the Braze SDK will handle all analytics tracking, dismissals, and rendering for a user’s Content Cards.

Customization

You can use these additional methods to build a custom Content Cards Feed within your app by using the following methods available on the plugin public interface:

Receiving Content Card data

To receive Content Card data in your Flutter app, the BrazePlugin supports sending Content Card data using Dart Streams (recommended) or by using a data callback (legacy).

The BrazeContentCard object supports a subset of fields available in the native model objects, including description, title, image, url, extras, and more.

Method 1: Content Card data streams (recommended)

You can set a data stream listener in Dart to receive Content Card data in your Flutter app.

To begin listening to the stream, use the code below to create a StreamSubscription in your Flutter app and call the subscribeToContentCards() method with a function that takes a List<BrazeContentCard> instance. Remember to cancel() the stream subscription when it is no longer needed.

1
2
3
4
5
6
7
8
9
// Create stream subscription
StreamSubscription contentCardsStreamSubscription;

contentCardsStreamSubscription = _braze.subscribeToContentCards((List<BrazeContentCard> contentCards) {
  // Function to handle Content Cards
}

// Cancel stream subscription
contentCardsStreamSubscription.cancel();

For an example, see main.dart in our sample app.

Method 2: Content Card data callback (Legacy)

You may set a callback in Dart to receive Braze Content Card data in the Flutter host app.

To set the callback, call braze.setBrazeContentCardsCallback() from your Flutter app with a function that takes a List<BrazeContentCard> instance.

• Android
• iOS

Replaying the callback for Content Cards

To store any Content Cards triggered before the callback is available and replay them once it is set, add the following entry to the customConfigs map when initializing the BrazePlugin:

1
BrazePlugin braze = new BrazePlugin(customConfigs: {replayCallbacksConfigKey: true});

Test displaying sample Content Card

Follow these steps to test a sample Content Card.

1. Set an active user in the React application by calling braze.changeUserId('your-user-id') method.
2. Head to Campaigns and follow this guide to create a new Content Card campaign.
3. Compose your test Content Card campaign and head over to the Test tab. Add the same user-id as the test user and click Send Test.
4. Tap the push notification and that should launch a Content Card on your device. You may need to refresh your feed for it to display.

For more details on each platform, follow the Android integration or iOS integration guides.