braze-android-sdk/com.braze.models.cards/Card

Card

open class Card constructor(jsonObject: JSONObject, cardKeysProvider: CardKey.Provider, brazeManager: IBrazeManager?, cardStorage: ICardStorageProvider<*>?, cardAnalytics: ICardAnalyticsProvider?) : IPutIntoJson<JSONObject?>

Creates a card.

Parameters

jsonObject

JSON representation of the card

cardKeysProvider

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

brazeManager

Allows the card to report clicks internally

cardStorage

Allows the card to persist its viewed/unviewed state

Throws

JSONException

When the provided JSON object is malformed

Constructors

Card

fun Card(jsonObject: JSONObject, cardKeyProvider: CardKey.Provider)

Card

fun Card(jsonObject: JSONObject, cardKeysProvider: CardKey.Provider, brazeManager: IBrazeManager?, cardStorage: ICardStorageProvider<*>?, cardAnalytics: ICardAnalyticsProvider?)

Types

Companion

object Companion

Functions

equals

open operator override fun equals(other: Any?): Boolean

Compares against another Card instance.

forJsonPut

open override fun forJsonPut(): JSONObject

The JSONObject representation of this card.

hashCode

open override fun hashCode(): Int

isInCategorySet

fun isInCategorySet(categories: EnumSet<CardCategory>): Boolean

isValidCard

fun isValidCard(): Boolean

logClick

fun logClick(): Boolean

Reports this card was clicked.

logImpression

fun logImpression(): Boolean

Reports that this card was displayed to the user.

toString

open override fun toString(): String

Properties

cardType

open val cardType: CardType

The CardType representing the type of this card or CardType.DEFAULT if the type is not known.

categories

var categories: EnumSet<CardCategory>? = null

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

channel

val channel: Channel

created

val created: Long

The UNIX creation time of this Card, in seconds.

expiresAt

val expiresAt: Long

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

extras

val extras: Map<String, String>

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

val id: String

isClicked

var isClicked: Boolean

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.

isContentCard

val isContentCard: Boolean

isControl

val isControl: Boolean

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

isDismissed

var isDismissed: Boolean

Indicates if this card is dismissed.

isDismissibleByUser

var isDismissibleByUser: Boolean

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

isExpired

val isExpired: Boolean

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

isIndicatorHighlighted

var isIndicatorHighlighted: Boolean

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

isPinned

var isPinned: Boolean

Whether this card is pinned.

isRemoved

val isRemoved: Boolean

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

isTest

var isTest: Boolean

Whether this Card arrived from a Braze Dashboard test send.

listener

var listener: ICardListener? = null

The ICardListener that gets called when isIndicatorHighlighted is set.