From 61e0baa78e26cbee855f0e89ccd50c420a0a16a6 Mon Sep 17 00:00:00 2001 From: Jeriel Ng Date: Mon, 3 Jun 2024 09:22:54 -0400 Subject: [PATCH 1/4] Clarifying updates to Cordova push documentation --- .../cordova/push_notifications.md | 32 ++++++++++++------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md index 5272671a4fa..00a22c4c029 100644 --- a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md +++ b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md @@ -13,21 +13,31 @@ channel: push # Push notification integration -> Learn how to integrate basic iOS push notifications for the Cordova Braze SDK. Rich push notifications and push stories are already available for Android by default. To integrate full push notification capabilities for either platform, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) or [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification integration guides. +> Learn how to integrate push notifications for the Cordova Braze SDK. + +## Basic push functionality + +Basic push notification features are enabled by default in the Braze Cordova plugin. You may disable this default behavior by customizing your XML configurations. Refer to our [Customization options]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options) for more details. + +For a more in-depth native integration for either platform, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) or [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification integration guides. + +{% multi_lang_include cordova/prerequisites.md %} + +## Extended push features {% alert important %} Anytime you add, remove, or update your Cordova plugins, Cordova will overwrite the Podfile in your Xcode project. This means you'll need to repeat this process anytime you modify your Cordova plugins. {% endalert %} -{% multi_lang_include cordova/prerequisites.md %} +This section describes additional push notification integrations on iOS. Rich push notifications and push stories are already available for Android by default. -## Rich push notifications +### Rich push notifications -### Step 1: Create a notification service extension +#### Step 1: Create a notification service extension In your Xcode project, create a notification service extension. For a full walkthrough, see [iOS Rich Push Notifications Tutorial](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/b2-rich-push-notifications). -### Step 2: Add a new target +#### Step 2: Add a new target Open your Podfile and add `BrazeNotificationService` to the notification service extension target [you just created](#step-1-create-a-notification-service-extension). If `BrazeNotificationService` is already added to a target, remove it before continuing. To avoid duplicate symbol errors, use static linking. @@ -47,7 +57,7 @@ target 'MyAppRichNotificationService' do end ``` -### Step 3: Reinstall your CocoaPods dependencies +#### Step 3: Reinstall your CocoaPods dependencies In the terminal, go to your project's iOS directory and reinstall your CocoaPod dependencies. @@ -56,13 +66,13 @@ cd PATH_TO_PROJECT/platform/ios pod install ``` -## Push stories +### Push stories -### Step 1: Create a notification content extension +#### Step 1: Create a notification content extension In your Xcode project, create a notification content extension. For a full walkthrough, see [iOS Push Stories Tutorial](https://braze-inc.github.io/braze-swift-sdk/tutorials/braze/b3-push-stories/). -### Step 2: Configure your push app group +#### Step 2: Configure your push app group In your project's `config.xml` file, configure the push app group [you just created](#step-1-create-a-notification-content-extension). @@ -76,7 +86,7 @@ Replace `PUSH_APP_GROUP` with the name of your push app group. Your `config.xml` ``` -### Step 3: Add a new target +#### Step 3: Add a new target Open your Podfile and add `BrazePushStory` to the notification content extension target [you created previously](#step-1-create-a-notification-content-extension). To avoid duplicate symbol errors, use static linking. @@ -96,7 +106,7 @@ target 'MyAppNotificationContentExtension' do end ``` -### Step 4: Reinstall your CocoaPods dependencies +#### Step 4: Reinstall your CocoaPods dependencies In the terminal, go to your iOS directory and reinstall your CocoaPod dependencies. From 82522ff0d91f8ea55945125eefb1e7a1126351fb Mon Sep 17 00:00:00 2001 From: Jeriel Ng Date: Mon, 3 Jun 2024 14:07:50 -0400 Subject: [PATCH 2/4] Update push_notifications.md --- .../platform_integration_guides/cordova/push_notifications.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md index 00a22c4c029..b7489d1b81d 100644 --- a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md +++ b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md @@ -15,14 +15,14 @@ channel: push > Learn how to integrate push notifications for the Cordova Braze SDK. +{% multi_lang_include cordova/prerequisites.md %} + ## Basic push functionality Basic push notification features are enabled by default in the Braze Cordova plugin. You may disable this default behavior by customizing your XML configurations. Refer to our [Customization options]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options) for more details. For a more in-depth native integration for either platform, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) or [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification integration guides. -{% multi_lang_include cordova/prerequisites.md %} - ## Extended push features {% alert important %} From c71202f73b2458d1ad67b0e56aac27dc1a409711 Mon Sep 17 00:00:00 2001 From: Isaiah Robinson <95643215+internetisaiah@users.noreply.github.com> Date: Mon, 3 Jun 2024 13:23:59 -0700 Subject: [PATCH 3/4] tech writer edits --- .../cordova/push_notifications.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md index b7489d1b81d..e1b615fc02a 100644 --- a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md +++ b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md @@ -17,11 +17,9 @@ channel: push {% multi_lang_include cordova/prerequisites.md %} -## Basic push functionality +## Basic push features -Basic push notification features are enabled by default in the Braze Cordova plugin. You may disable this default behavior by customizing your XML configurations. Refer to our [Customization options]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options) for more details. - -For a more in-depth native integration for either platform, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) or [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification integration guides. +By default, all basic push notification features are enabled in the Braze Cordova plugin. You disable these features by [customizing your XML configurations]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options). For more in-depth native features, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) and [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification guides. ## Extended push features @@ -29,8 +27,6 @@ For a more in-depth native integration for either platform, see the [iOS]({{site Anytime you add, remove, or update your Cordova plugins, Cordova will overwrite the Podfile in your Xcode project. This means you'll need to repeat this process anytime you modify your Cordova plugins. {% endalert %} -This section describes additional push notification integrations on iOS. Rich push notifications and push stories are already available for Android by default. - ### Rich push notifications #### Step 1: Create a notification service extension From 63109cd418d2736c5bc1e0c45f777a2e6e238955 Mon Sep 17 00:00:00 2001 From: Isaiah Robinson <95643215+internetisaiah@users.noreply.github.com> Date: Mon, 3 Jun 2024 13:27:22 -0700 Subject: [PATCH 4/4] tech writer edits --- .../platform_integration_guides/cordova/push_notifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md index e1b615fc02a..a1b38ba23c6 100644 --- a/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md +++ b/_docs/_developer_guide/platform_integration_guides/cordova/push_notifications.md @@ -19,7 +19,7 @@ channel: push ## Basic push features -By default, all basic push notification features are enabled in the Braze Cordova plugin. You disable these features by [customizing your XML configurations]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options). For more in-depth native features, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) and [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification guides. +By default, basic push notification features are enabled in the Braze Cordova plugin. You can disable these features by [customizing your XML configurations]({{site.baseurl}}/developer_guide/platform_integration_guides/cordova/initial_setup/customizations/#customization-options). For more in-depth native push notification features, see the [iOS]({{site.baseurl}}/developer_guide/platform_integration_guides/swift/push_notifications/integration/) and [Android]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/integration/standard_integration/) push notification guides. ## Extended push features