com.appboy.models.cards

Class Card

java.lang.Object

java.util.Observable

com.appboy.models.cards.Card

All Implemented Interfaces:

IPutIntoJson<org.json.JSONObject>

Direct Known Subclasses:

BannerImageCard, CaptionedImageCard, ControlCard, ShortNewsCard, TextAnnouncementCard

public class Card
extends java.util.Observable
implements IPutIntoJson<org.json.JSONObject>

Constructor Summary

Constructors

Constructor and Description
Card(org.json.JSONObject object, CardKey.Provider cardKeyProvider)
Card(org.json.JSONObject object, CardKey.Provider cardKeysProvider, IBrazeManager manager, ICardStorageProvider<?> cardStorageProvider, ICardAnalyticsProvider cardAnalyticsProvider) Creates a card.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object otherCard) Compares against another Card instance.
org.json.JSONObject	forJsonPut() The JSONObject representation of this card.
CardType	getCardType() Returns a CardType representing the type of this card.
java.util.EnumSet<CardCategory>	getCategories() Returns the categories for this Feed card.
long	getCreated()
long	getExpiresAt() Gets the expiration date of the card.
java.util.Map<java.lang.String,java.lang.String>	getExtras()
java.lang.String	getId()
boolean	getIsDismissibleByUser()
boolean	getIsPinned()
boolean	getOpenUriInWebView()
long	getUpdated()
java.lang.String	getUrl()
boolean	getViewed()
int	hashCode()
boolean	isClicked() Gets the clicked state of this card.
boolean	isContentCard()
boolean	isControl() Returns whether this card is a control card.
boolean	isDismissed()
boolean	isEqualToCard(Card card) Deprecated. Please use equals(Object) instead.
boolean	isExpired()
boolean	isInCategorySet(java.util.EnumSet<CardCategory> categories)
boolean	isIndicatorHighlighted() Gets whether the visual indicator at the bottom of the card is highlighted.
boolean	isRead() Deprecated. See isIndicatorHighlighted()
boolean	isRemoved()
boolean	isTest()
boolean	logClick() Reports this card was clicked.
boolean	logImpression() Reports that this card was displayed to the user.
void	setIndicatorHighlighted(boolean enabled) Sets the visual indicator at the bottom of the card is highlighted.
void	setIsDismissed(boolean isDismissed) Sets a card as dismissed.
void	setIsDismissibleByUser(boolean isDismissible) Sets whether this card can be dismissed by the user.
void	setIsPinned(boolean isPinned) Sets this card as pinned in the default UI.
void	setIsRead(boolean read) Deprecated. See setIndicatorHighlighted(boolean)
void	setIsTest(boolean isTest)
void	setViewed(boolean viewed) This should be set to true when a card has it's impression logged.
java.lang.String	toString()

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Card

public Card(org.json.JSONObject object,
            CardKey.Provider cardKeyProvider)
     throws org.json.JSONException

Throws:

org.json.JSONException

Card

public Card(org.json.JSONObject object,
            CardKey.Provider cardKeysProvider,
            IBrazeManager manager,
            ICardStorageProvider<?> cardStorageProvider,
            ICardAnalyticsProvider cardAnalyticsProvider)
     throws org.json.JSONException

Creates a card.

Parameters:

object - JSON representation of the card

cardKeysProvider - The CardKey.Provider responsible for providing the appropriate key for a field.

manager - Allows the card to report clicks internally

cardStorageProvider - Allows the card to persist its viewed/unviewed state

Throws:

org.json.JSONException - When the provided JSON object is malformed

Method Detail

logImpression

public boolean logImpression()

Reports that this card was displayed to the user.

Card impressions tracks how many times a card has been seen. Impressions should only be reported once the card becomes viewable to the user. Cards that are part of the stream but not visible should not log a card impression. If a card is viewed more than once in a particular view, it generates only one impression. If closed and reopened, a card will again generate an impression.

logClick

public boolean logClick()

Reports this card was clicked.

isClicked

public boolean isClicked()

Gets the clicked state of this card. Note that clicks are stored on disk so subsequent instances of this card will retain its clicked state upon recreation.

Returns:

True if this card is marked as clicked, otherwise returns false.

isRead

@Deprecated
public boolean isRead()

Deprecated. See isIndicatorHighlighted()

Note that this field is not to be associated with analytics in any way.

Returns:

the current status of the read/unread visual indicator on the card.

isIndicatorHighlighted

public boolean isIndicatorHighlighted()

Gets whether the visual indicator at the bottom of the card is highlighted. Note that this field is not to be associated with analytics in any way.

Returns:

The current status of visual indicator highlight state. This value changes from true to false when the card goes offscreen for the first time.

setIsRead

@Deprecated
public void setIsRead(boolean read)

Deprecated. See setIndicatorHighlighted(boolean)

Note that this field is not to be associated with analytics in any way.

setIndicatorHighlighted

public void setIndicatorHighlighted(boolean enabled)

Sets the visual indicator at the bottom of the card is highlighted. Note that this field is not to be associated with analytics in any way.

isDismissed

public boolean isDismissed()

Returns:

True if this card is dismissed, otherwise returns false.

setIsDismissed

public void setIsDismissed(boolean isDismissed)

Sets a card as dismissed. Note that if a card is already marked as dismissed, it cannot be marked as dismissed again.

getViewed

public boolean getViewed()

Returns:

whether this card has had its impression logged already.

setViewed

public void setViewed(boolean viewed)

This should be set to true when a card has it's impression logged. Note: this method does not log analytics.

isEqualToCard

@Deprecated
public boolean isEqualToCard(Card card)

Deprecated. Please use equals(Object) instead.

getId

public java.lang.String getId()

Returns:

The unique identifier for this Card.

getExtras

public java.util.Map<java.lang.String,java.lang.String> getExtras()

Returns:

a map of key-value pair extras for this card.

getUrl

public java.lang.String getUrl()

Returns:

the url string associated with the card click action or null if not implemented by child class.

getIsPinned

public boolean getIsPinned()

Returns:

whether this card is pinned.

getOpenUriInWebView

public boolean getOpenUriInWebView()

Returns:

whether Uris for this card should be opened in Appboy's WebView or not.

getCreated

public long getCreated()

Returns:

The UNIX creation time of this Card, in seconds.

getUpdated

public long getUpdated()

Returns:

The UNIX last update time of this Card, in seconds.

isRemoved

public boolean isRemoved()

Returns:

True if this card was marked as removed, false otherwise.

getIsDismissibleByUser

public boolean getIsDismissibleByUser()

Returns:

True if this card is dismissable by the user, false otherwise.

setIsDismissibleByUser

public void setIsDismissibleByUser(boolean isDismissible)

Sets whether this card can be dismissed by the user.

Parameters:

isDismissible - The new value for whether this card can be dismissed by the user.

setIsPinned

public void setIsPinned(boolean isPinned)

Sets this card as pinned in the default UI.

Parameters:

isPinned - The new pinned status.

getExpiresAt

public long getExpiresAt()

Gets the expiration date of the card. Values < 0 mean the card never expires.

isExpired

public boolean isExpired()

Returns:

True if this card's expiration date has already passed.

getCategories

public java.util.EnumSet<CardCategory> getCategories()

Returns the categories for this Feed card. Note that this value will be null for ContentCards.

isInCategorySet

public boolean isInCategorySet(java.util.EnumSet<CardCategory> categories)

Parameters:

categories -

Returns:

True if this News Feed card is contained in the argument categories.

getCardType

public CardType getCardType()

Returns a CardType representing the type of this card.

Returns:

the card type or CardType.DEFAULT if the type is not known.

isControl

public boolean isControl()

Returns whether this card is a control card. Control cards should not be displayed to the user.

isContentCard

public boolean isContentCard()

Returns:

Whether this Card originally represented a Content Card.

setIsTest

public void setIsTest(boolean isTest)

isTest

public boolean isTest()

Returns:

Whether this Card arrived from a Braze Dashboard test send.

forJsonPut

public org.json.JSONObject forJsonPut()

The JSONObject representation of this card.

Specified by:

forJsonPut in interface IPutIntoJson<org.json.JSONObject>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object otherCard)

Compares against another Card instance.

Overrides:

equals in class java.lang.Object

Returns:

True if this card shares the same getUpdated() time, and unique getId().

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object