diff --git a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/content_cards.md b/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/content_cards.md deleted file mode 100644 index 0ab8fb3272b..00000000000 --- a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/content_cards.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -nav_title: Content Cards -article_title: In-App Messages for tvOS -description: "This reference article covers Content Card integration guidelines for the tvOS platform." -layout: redirect -redirect_to: /docs/developer_guide/platform_integration_guides/tvos/in-app_messaging/ -page_order: 2 -noindex: true ---- \ No newline at end of file diff --git a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/in-app_messaging.md b/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/in-app_messaging.md deleted file mode 100644 index 749286376ba..00000000000 --- a/_docs/_developer_guide/platform_integration_guides/legacy_sdks/tvos/in-app_messaging.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -nav_title: In-App Messages -article_title: In-App Messages for tvOS -platform: tvOS -page_type: reference -description: "This reference article covers in-app messaging integration guidelines for the tvOS platform." -page_order: 3 -noindex: true ---- - -{% multi_lang_include archive/objective-c-deprecation-notice.md %} - -# In-app message and Content Card integration - -> This article covers how to set up in-app messages and Content Cards for tvOS. Note that in-app message and Content Card support on tvOS is only available using our Swift SDK. - -On tvOS, you can execute messaging on both in-app message and Content Card channels by integrating the [Braze Swift SDK][swift-sdk]. After adding the Braze SDK to your Xcode project for your tvOS app, note the following details during your configuration: - -**1\.** Create a new iOS app under **Manage Settings** in the Braze dashboard for your tvOS app.
![][1]{: style="width:70%"}
-{% alert warning %} -Do not choose tvOS from the checkbox list; doing so will prohibit you from leveraging Content Cards or in-app messages. -{% endalert %} - -**2\.** Use the API key listed in **Manage Settings** when referencing the API key during your SDK configuration in your Xcode project.
![][2]{: style="width:70%"} - -## Customization - -Braze does not provide default UIs for Content Cards or in-app messages on tvOS. - -Reference our [In-app message custom UI](https://braze-inc.github.io/braze-swift-sdk/documentation/braze/in-app-message-customization) and [Content Cards custom UI](https://braze-inc.github.io/braze-swift-sdk/documentation/braze/content-cards-customization) articles to further customize these channels on tvOS when integrating. We also offer [example projects](https://github.com/braze-inc/braze-swift-sdk/tree/main/Examples) to reference as well to aid in the integration. - -[1]: {% image_buster /assets/img/tvos.png %} -[2]: {% image_buster /assets/img/tvos1.png %} -[swift-sdk]: https://github.com/braze-inc/braze-swift-sdk diff --git a/_docs/_developer_guide/platform_integration_guides/swift/content_cards/integration.md b/_docs/_developer_guide/platform_integration_guides/swift/content_cards/integration.md index 76f0017ab39..e224a612446 100644 --- a/_docs/_developer_guide/platform_integration_guides/swift/content_cards/integration.md +++ b/_docs/_developer_guide/platform_integration_guides/swift/content_cards/integration.md @@ -2,7 +2,7 @@ nav_title: Integration article_title: Content Card Integration for iOS platform: Swift -page_order: 1 +page_order: 0 description: "This article covers the integration steps, data models, and card-specific properties available in the Swift SDK." channel: - content cards diff --git a/_docs/_developer_guide/platform_integration_guides/swift/content_cards/tvos.md b/_docs/_developer_guide/platform_integration_guides/swift/content_cards/tvos.md new file mode 100644 index 00000000000..db64c84f707 --- /dev/null +++ b/_docs/_developer_guide/platform_integration_guides/swift/content_cards/tvos.md @@ -0,0 +1,38 @@ +--- +nav_title: tvOS +article_title: Content Cards for tvOS +platform: tvOS +page_type: reference +description: "Learn how to customize your Content Cards for Apple's tvOS platform." +page_order: 1 +--- + +# Customizing Content Cards for tvOS + +> Learn how to customize your Content Cards for Apple's tvOS platform. + +## Setting up your tvOS app + +### Step 1: Create a new iOS app + +In Braze, select **Settings** > **App Settings**, then select **Add App**. Enter a name for your tvOS app, select **iOS**—_not tvOS_—then select **Add App**. + +![ALT_TEXT.]({% image_buster /assets/img/tvos.png %}){: style="width:70%"} + +{% alert warning %} +If you select the **tvOS** checkbox, you will not be able to customize Content Cards for tvOS. +{% endalert %} + +### Step 2: Get your app's API key + +In your app settings, select your new tvOS app then take note of your app's API key. You'll use this key to configure your app in Xcode. + +![ALT_TEXT]({% image_buster /assets/img/tvos1.png %}){: style="width:70%"} + +### Step 3: Integrate the Braze Swift SDK + +Use your app's API key to integrate the [Braze Swift SDK](https://github.com/braze-inc/braze-swift-sdk) into your tvOS project in Xcode. When you're finished, you can [customize your Content Cards for tvOS](#customizing-your-in-app-messages). + +## Customizing your content cards + +Because Braze doesn't provide a default UI for Content Cards on tvOS, you'll need to customize them yourself. For a full walkthrough, see our step-by-step tutorial: [Customizing Content Cards for tvOS](https://braze-inc.github.io/braze-swift-sdk/documentation/braze/content-cards-customization/). For a sample project, see [Braze Swift SDK samples](https://github.com/braze-inc/braze-swift-sdk/tree/main/Examples). diff --git a/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/customization/tvos.md b/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/customization/tvos.md new file mode 100644 index 00000000000..5d6b4ba5609 --- /dev/null +++ b/_docs/_developer_guide/platform_integration_guides/swift/in-app_messaging/customization/tvos.md @@ -0,0 +1,38 @@ +--- +nav_title: tvOS +article_title: In-App Messages for tvOS +platform: tvOS +page_type: reference +description: "Learn how to customize your in-app messages for Apple's tvOS platform." +page_order: 0 +--- + +# Customizing in-app messages for tvOS + +> Learn how to customize your in-app messages for Apple's tvOS platform. + +## Setting up your tvOS app + +### Step 1: Create a new iOS app + +In Braze, select **Settings** > **App Settings**, then select **Add App**. Enter a name for your tvOS app, select **iOS**—_not tvOS_—then select **Add App**. + +![ALT_TEXT.]({% image_buster /assets/img/tvos.png %}){: style="width:70%"} + +{% alert warning %} +If you select the **tvOS** checkbox, you will not be able to customize in-app messages for tvOS. +{% endalert %} + +### Step 2: Get your app's API key + +In your app settings, select your new tvOS app then take note of your app's API key. You'll use this key to configure your app in Xcode. + +![ALT_TEXT]({% image_buster /assets/img/tvos1.png %}){: style="width:70%"} + +### Step 3: Integrate the Braze Swift SDK + +Use your app's API key to integrate the [Braze Swift SDK](https://github.com/braze-inc/braze-swift-sdk) into your tvOS project in Xcode. When you're finished, you can [customize your in-app messages for tvOS](#customizing-your-in-app-messages). + +## Customizing your in-app messages + +Because Braze doesn't provide a default UI for in-app messages on tvOS, you'll need to customize it yourself. For a full walkthrough, see our step-by-step tutorial: [Customizing in-app messages for tvOS](https://braze-inc.github.io/braze-swift-sdk/documentation/braze/in-app-message-customization). For a sample project, see [Braze Swift SDK samples](https://github.com/braze-inc/braze-swift-sdk/tree/main/Examples). diff --git a/assets/js/broken_redirect_list.js b/assets/js/broken_redirect_list.js index 9f45f247534..92d5ebbf6cc 100644 --- a/assets/js/broken_redirect_list.js +++ b/assets/js/broken_redirect_list.js @@ -1131,6 +1131,11 @@ validurls['/docs/one-click_unsubscribe/'] = '/docs/user_guide/administrative/app validurls['/docs/back_in_stock/'] = '/docs/user_guide/personalization_and_dynamic_content/catalogs/back_in_stock_notifications/'; +validurls['/docs/developer_guide/platform_integration_guides/legacy_sdks/tvos/in-app_messaging/'] = '/docs/developer_guide/platform_integration_guides/swift/in-app_messaging/customization/tvos/'; +validurls['/docs/developer_guide/platform_integration_guides/legacy_sdks/tvos/content_cards/'] = '/docs/developer_guide/platform_integration_guides/swift/content_cards/tvos/'; +validurls['/docs/developer_guide/platform_integration_guides/tvos/in-app_messaging/'] = '/docs/developer_guide/platform_integration_guides/swift/in-app_messaging/customization/tvos/'; +validurls['/docs/developer_guide/platform_integration_guides/tvos/content_cards/'] = '/docs/developer_guide/platform_integration_guides/swift/content_cards/tvos/'; + validurls['/docs/engagement_by_device/'] = '/docs/user_guide/data_and_analytics/analytics/email_performance_dashboard/#engagement-by-device/'; // validurls['OLD'] = 'NEW';