Skip to content

Commit

Permalink
Merge pull request #7836 from braze-inc/BD-3202
Browse files Browse the repository at this point in the history
[BD-3202] Clarifying headless UI for Apple TV
  • Loading branch information
internetisaiah authored Aug 7, 2024
2 parents 5c7f2a8 + 7ce3045 commit dd9b0a3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ page_order: 1

> Learn how to customize your Content Cards for Apple's tvOS platform.
{% alert important %}
Keep in mind, you'll need to implement your own custom UI since Content Cards are supported via headless UI using the Swift SDK—which does not include any default UI or views for tvOS.
{% endalert %}

## Setting up your tvOS app

### Step 1: Create a new iOS app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ page_order: 0

> Learn how to customize your in-app messages for Apple's tvOS platform.
{% alert important %}
Keep in mind, you'll need to implement your own custom UI since in-app messaging is supported via headless UI using the Swift SDK—which does not include any default UI or views for tvOS.
{% endalert %}

## Setting up your tvOS app

### Step 1: Create a new iOS app
Expand Down
12 changes: 6 additions & 6 deletions _docs/_developer_guide/platform_integration_guides/tv_and_ott.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following lists features and messaging channels supported today.
<th>Content Cards</th>
<th>Push notifications</th>
<th>Canvas</th>
<th>[Feature Flags](https://www.braze.com/docs/developer_guide/platform_wide/feature_flags/about)</th>
<th>Feature Flags</th>
</tr>
</thead>
<tbody>
Expand Down Expand Up @@ -214,7 +214,7 @@ For more information, visit the [Roku integration guide][3].

### Apple TV OS {#tvos}

Use the Braze Swift SDK to integrate with tvOS.
Use the Braze Swift SDK to integrate with tvOS. Keep in mind, the Swift SDK doesn't include any default UI or views for tvOS, so you will need to implement your own.

Features include:

Expand Down Expand Up @@ -257,11 +257,11 @@ To target OTT apps for messaging, we recommend creating a segment specific to yo

## Headless UI {#custom-ui}

For platforms that support in-app messages or Content Cards via headless UI, Braze will deliver a data model, such as JSON, that your app can read and use within a UI your app controls. These platforms don't include any default UI or views.

This data will contain the fields configured in the dashboard (title, body, button text, colors, etc.) which your app can read and display accordingly.
{% alert important %}
Platforms that support in-app messages or Content Cards via headless UI **do not** include any default UI or views, so be sure to implement your own custom UI.
{% endalert %}

Read more about custom handling messaging:
With headless UI, Braze will deliver a data model, such as JSON, that your app can read and use within a UI your app controls. This data will contain the fields configured in the dashboard (title, body, button text, colors, etc.) which your app can read and display accordingly. For more information about custom handling messaging, see the following:

**Android SDK**
- [In-App Message Customization](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/in-app_messaging/customization/custom_listeners/)
Expand Down

0 comments on commit dd9b0a3

Please sign in to comment.