Badges

Requesting unread Content Card counts

If you want to display the number of unread Content Cards your user has, we suggest you request a card count and represent it with a Badge. Badges are a great way to call attention to new content awaiting your users in the Content Cards. If you’d like to add a badge to your Content Cards, the Braze SDK provides methods to query the following:

• Unviewed Content Cards for the current user
• Total Viewable Content Cards for the current user

The following method declarations in ABKContentCardsController describe this in detail:

1
2
3
4
5
6
7
8
9
10
11
12
- (NSInteger)unviewedContentCardCount;
/*
This method returns the number of currently active Content Cards that have not been viewed.
A "view" happens when a card becomes visible in the Content Cards view. This differentiates between cards that are off-screen in the scrolling view and those which are on-screen; when a card scrolls onto the screen, it's counted as viewed.
Cards are counted as viewed only once -- if a card scrolls off the screen and back on, it's not re-counted.
Cards are counted only once, even if they appear in multiple Content Cards views or across multiple devices.
*/

- (NSInteger)contentCardCount;
/* 
This method returns the total number of currently active Content Cards. Cards are counted only once even if they appear in multiple Content Cards views.
 */

Displaying the number of unviewed Content Cards on the app badge count

In addition to serving as push notification reminders for an app, badges can also be utilized to denote unviewed items in the user’s Content Cards feed. Updating the badge count based on unviewed Content Cards updates can be valuable in attracting users back to your app and increasing sessions.

This method records the badge count after the app is closed and the user’s session ends:

• objective-c
• swift

1
(void)applicationDidEnterBackground:(UIApplication *)application

1
[UIApplication sharedApplication].applicationIconBadgeNumber = [[Appboy sharedInstance].contentCardsController unviewedContentCardCount];

1
func applicationDidEnterBackground(_ application: UIApplication)

1
2
UIApplication.shared.applicationIconBadgeNumber =
  Appboy.sharedInstance()?.contentCardsController.unviewedContentCardCount() ?? 0

For more information see the Appboy.h header file.