Modules

Card

Abstract base for news feed cards. Use subclasses ClassicCard, CaptionedImage, Banner, and ControlCard.

Hierarchy

Index

Properties

Methods

Properties

expiresAt

expiresAt: Date | null

When this card expires and should stop being shown to the user.

Optional extras

extras: Record<string, any>

Object of string/string key/value pairs.

Optional id

id: string

The id of the card. This will be reported back to Braze with events for analytics purposes.

pinned

pinned: boolean

Whether to pin this card to the top of the view.

updated

updated: Date | null

When this card was last modified.

viewed

viewed: boolean

Whether this card has been shown to the user.

Methods

dismissCard

  • dismissCard(): void

  • Call this method if you wish to dismiss this card programmatically.

    Returns void

removeAllSubscriptions

  • removeAllSubscriptions(): void

  • Remove all event subscriptions from this message.

    Returns void

removeSubscription

  • removeSubscription(subscriptionGuid: string): void

  • Remove an event subscription that you previously subscribed to.

    Parameters

    • subscriptionGuid: string

      The identifier of the subscription you wish to remove, returned by the method you initially used to create it.

    Returns void

subscribeToClickedEvent

  • subscribeToClickedEvent(subscriber: () => void): string

  • Subscribe to receive click events. The subscriber callback will be called whenever this card is clicked by the user.

    Parameters

    • subscriber: () => void

      The callback function to receive click events. This function will be invoked with no arguments when this card records a click.

        • (): void

        • Returns void

    Returns string

    The identifier of the subscription created. This can be passed to Card.removeSubscription to cancel the subscription.

subscribeToDismissedEvent

  • subscribeToDismissedEvent(subscriber: () => void): string

  • Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the user.

    Parameters

    • subscriber: () => void

      The callback function to receive dismissed events. This function will be invoked with no arguments when this card records a dismissal.

        • (): void

        • Returns void

    Returns string

    The identifier of the subscription created. This can be passed to Card.removeSubscription to cancel the subscription.