Braze React Native SDK - v21.0.0
    Preparing search index...

    Interface CaptionedContentCard

    The Captioned Content Card, extending ContentCardBase.

    interface CaptionedContentCard {
        cardDescription: string;
        clicked: boolean;
        created: number;
        dismissed: boolean;
        dismissible: boolean;
        domain?: string;
        expiresAt: number;
        extras: { [key: string]: string };
        id: string;
        image: string;
        imageAspectRatio: number;
        isControl: boolean;
        openURLInWebView: boolean;
        pinned: boolean;
        title: string;
        type: "Captioned";
        url?: string;
        viewed: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cardDescription clicked created dismissed dismissible domain? expiresAt extras id image imageAspectRatio isControl openURLInWebView pinned title type url? viewed

    Properties

    cardDescription: string

    The description text for the card.

    clicked: boolean

    Indicates whether the card has been clicked by the user. Note: Clicks are stored on disk, so subsequent instances of this card will retain its clicked state upon recreation.

    created: number

    The UNIX timestamp of the card's creation time from Braze dashboard.

    dismissed: boolean

    Indicates whether the card has been dismissed. Marking a card as dismissed that has already been dismissed will be a no-op.

    dismissible: boolean

    Indicates whether the card is dismissible by the user.

    domain?: string

    (Optional) The link text for the property URL, e.g., "blog.appboy.com". It can be displayed on the card's UI to indicate the action/direction of clicking on the card.

    expiresAt: number

    The UNIX timestamp of the card's expiration time. When the value is less than 0, it means the card never expires.

    extras: { [key: string]: string }

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

    id: string

    The card's ID.

    image: string

    The URL of the card's image.

    imageAspectRatio: number

    The aspect ratio of the card's image. It is meant to serve as a hint before image loading completes. Note that the property may not be supplied in certain circumstances.

    isControl: boolean

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

    openURLInWebView: boolean

    Indicates whether URLs for this card should be opened in Braze's WebView or not. When false, the URL will be opened by the OS and web URLs will be opened in an external web browser app.

    pinned: boolean

    Indicates whether the card is pinned.

    title: string

    The title text for the card.

    type: "Captioned"

    The Content Card type.

    url?: string

    (Optional) The url string associated with the card click action.

    viewed: boolean

    Indicates whether the card has been read or is unread by the user. Note: This does not log analytics.