-
Notifications
You must be signed in to change notification settings - Fork 7
docs: add 4.5.0 automatic push integration flags to Android migration guide + README #520
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
55235a3
fcc8cc1
509b789
e44edea
6e66b4c
8aa04a6
3a654bb
2bc6c29
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,61 @@ | |
| This document provides guidance on how to migrate from one version of the SDK to a newer version. | ||
| It will be updated as new versions are released including deprecations or breaking changes. | ||
|
|
||
| # 4.5.0 | ||
|
|
||
| ## New Automatic Push Behaviors (Manifest Flags) | ||
|
|
||
| SDK 4.5.0 introduces two push behaviors controlled via `AndroidManifest.xml` metadata: | ||
| `automatic_push_open_tracking` (new, opt-in) and `automatic_push_token_forwarding` (**on by | ||
| default**, formalizing the SDK's existing automatic token forwarding). No action is required to | ||
| preserve your current behavior. If you manage push tokens manually and want to disable automatic | ||
| forwarding, opt out as described below. | ||
|
|
||
| ### `automatic_push_open_tracking` (opt-in, default **off**) | ||
|
|
||
| When enabled, the SDK automatically records push-open events without requiring you to call | ||
| `Klaviyo.handlePush` manually in your notification interaction handler. | ||
|
|
||
| To enable, add the following to the `<application>` element of your `AndroidManifest.xml`: | ||
|
|
||
| ```xml | ||
| <meta-data | ||
| android:name="com.klaviyo.push.automatic_push_open_tracking" | ||
| android:value="true" /> | ||
| ``` | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. small thing, but I would put the instructions in the README, and point the migration guide to the README for how to opt in/out of the flag.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nice suggestion! will make this change |
||
|
|
||
| This flag defaults to **off** in 4.5.0. It is expected to become the default (opt-out) in a future | ||
| major release. | ||
|
|
||
| ### `automatic_push_token_forwarding` (default **on**) | ||
|
|
||
| When this flag is enabled (which is the **default**), the SDK automatically registers the device's | ||
| FCM push token with Klaviyo on your behalf — you no longer need to call `Klaviyo.setPushToken` | ||
| manually on app startup. | ||
|
glenn-klaviyo marked this conversation as resolved.
|
||
|
|
||
| To opt out of automatic token forwarding and retain manual control, add the following to the | ||
| `<application>` element of your `AndroidManifest.xml`: | ||
|
|
||
| ```xml | ||
| <meta-data | ||
| android:name="com.klaviyo.push.automatic_push_token_forwarding" | ||
| android:value="false" /> | ||
| ``` | ||
|
|
||
| ### Rollout summary | ||
|
|
||
| | Behavior | This release (4.5.0) | Future major release | | ||
| |---|---|---| | ||
| | `automatic_push_token_forwarding` | Default on (opt-out via manifest) | Default on | | ||
| | `automatic_push_open_tracking` | Opt-in (default off) | Default on (opt-out) | | ||
|
|
||
| > **Anonymous profiles:** When `automatic_push_token_forwarding` is enabled (the Android default), | ||
| > the SDK registers the device's push token with Klaviyo automatically — at initialization, when the | ||
| > app returns to the foreground, and whenever FCM issues a new token — which can occur before you call | ||
| > `setProfile`, `setEmail`, or `setPhoneNumber`. This results in an anonymous profile being created in Klaviyo | ||
| > until you provide identifying information. This is expected behavior. See | ||
| > [Anonymous Tracking](./README.md#anonymous-tracking) in the README. | ||
|
|
||
| # 4.3.0 | ||
|
|
||
| ## New Modules for Cross-Platform Support | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.