The id of the card. This will be reported back to Braze with events for analytics purposes.
Whether this card has been shown to the user.
The title text for this card.
The url for this card's image.
The body text for this card.
When this card was created.
When this card was last modified.
Purely for organization in your custom implementation, these categories can be set in the dashboard composer.
When this card expires and should stop being shown to the user.
A url to open when this card is clicked.
The display text for the url.
The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes. Note that the field may not be supplied in certain circumstances.
Object of string/string key/value pairs.
Whether to pin this card to the top of the view.
Whether to allow the user to dismiss this card, removing it from the view.
Whether this card has ever been clicked on this device.
The aspect ratio for this card's image. This field is meant to serve as a hint before image loading completes. Note that the field may not be supplied in certain circumstances.
Purely for organization in your custom implementation, these categories can be set in the dashboard composer.
Whether this card has ever been clicked on this device.
When this card was created.
The body text for this card.
Whether this card has been dismissed.
Whether to allow the user to dismiss this card, removing it from the view.
When this card expires and should stop being shown to the user.
Object of string/string key/value pairs. Defaults to empty object {}.
The id of the card. This will be reported back to Braze with events for analytics purposes.
The url for this card's image.
Whether this card is a ControlCard.
The display text for the url.
Whether to pin this card to the top of the view.
The title text for this card.
When this card was last modified.
A url to open when this card is clicked.
Whether this card has been shown to the user.
Call this method if you wish to programmatically remove the card from the feed and log a dismissal. This method is meant to be used with the Braze UI.
If you are using your own UI, this method will have no effect. Instead, you should use logCardDismissal
to
log analytics and then remove the card from the DOM manually.
Remove all event subscriptions from this message.
Remove an event subscription that you previously subscribed to.
The identifier of the subscription you wish to remove, returned by the method you initially used to create it.
Subscribe to receive click events. The subscriber callback will be called whenever this card is clicked by the user.
The callback function to receive click events. This function will be invoked with no arguments when this card records a click.
The identifier of the subscription created. This can be passed to Card.removeSubscription
to cancel the subscription. Returns null if the subscriber passed is not a function.
Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the user.
The callback function to receive dismissed events. This function will be invoked with no arguments when this card records a dismissal.
The identifier of the subscription created. This can be passed to Card.removeSubscription
to cancel the subscription. Returns null if the subscriber passed is not a function.
A card with a title, body, and optionally a small image, which can be passed to
showFeed
or handled manually. Subscribe to receive new cards viasubscribeToFeedUpdates
.