com.appboy.events

Class FeedUpdatedEvent

java.lang.Object

com.appboy.events.FeedUpdatedEvent

public final class FeedUpdatedEvent
extends java.lang.Object

When Braze receives a new message feed in a server response, this event is fired. All of the cards in the feed are provided along with the id of the user that the feed is for (or null if no user id was set).

Constructor Summary

Constructors

Constructor and Description
FeedUpdatedEvent(java.util.List<Card> feedCards, java.lang.String userId, boolean isFromOfflineStorage, long timestamp)

Method Summary

Modifier and Type	Method and Description
int	getCardCount() The total number of cards in the feed.
int	getCardCount(CardCategory category)
int	getCardCount(java.util.EnumSet<CardCategory> categories)
java.util.List<Card>	getFeedCards() Guaranteed to not be null and to not include any null values in the list.
java.util.List<Card>	getFeedCards(CardCategory category)
java.util.List<Card>	getFeedCards(java.util.EnumSet<CardCategory> categories) Returns a list of cards where each card belongs to at least one of the given categories.
int	getUnreadCardCount() The number of unread cards in the feed.
int	getUnreadCardCount(CardCategory category)
int	getUnreadCardCount(java.util.EnumSet<CardCategory> categories)
java.lang.String	getUserId()
boolean	isFromOfflineStorage()
long	lastUpdatedInSecondsFromEpoch() The Unix timestamp (in seconds) of when this snapshot of the feed was last received from Braze's servers.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FeedUpdatedEvent

public FeedUpdatedEvent(java.util.List<Card> feedCards,
                        java.lang.String userId,
                        boolean isFromOfflineStorage,
                        long timestamp)

Method Detail

isFromOfflineStorage

public boolean isFromOfflineStorage()

getFeedCards

public java.util.List<Card> getFeedCards()

Guaranteed to not be null and to not include any null values in the list.

getFeedCards

public java.util.List<Card> getFeedCards(CardCategory category)

getFeedCards

public java.util.List<Card> getFeedCards(java.util.EnumSet<CardCategory> categories)

Returns a list of cards where each card belongs to at least one of the given categories. Guaranteed to not be null and to not include any null values in the list. When there are no cards in those categories, this method returns an empty list. When the passed in categories are null, all cards will be returned. When the passed in categories are an empty EnumSet, an empty list will be returned.

Parameters:

categories - an EnumSet of CardCategory. Please pass in a non-empty EnumSet of CardCategory, or a null. An empty EnumSet is considered invalid.

Returns:

a List of Cards for the given categories.

getUserId

public java.lang.String getUserId()

getCardCount

public int getCardCount()

The total number of cards in the feed.

getCardCount

public int getCardCount(CardCategory category)

getCardCount

public int getCardCount(java.util.EnumSet<CardCategory> categories)

getUnreadCardCount

public int getUnreadCardCount()

The number of unread cards in the feed.

getUnreadCardCount

public int getUnreadCardCount(CardCategory category)

getUnreadCardCount

public int getUnreadCardCount(java.util.EnumSet<CardCategory> categories)

lastUpdatedInSecondsFromEpoch

public long lastUpdatedInSecondsFromEpoch()

The Unix timestamp (in seconds) of when this snapshot of the feed was last received from Braze's servers.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object