Migrate from Android SDK v1 to v2
v1 is deprecated
As of December 31, 2022, the v1 SDK and Legacy Templates are considered deprecated.
Android SDK v2 brings support for Dynamic Flow Templates, which represent the next generation of Persona’s inquiry flow. Dynamic Flow Templates allow for greater flexibility in data collection by allowing custom UIs and collection fields.
Dynamic Flow Templates support versioning and fully custom, component-based views. If you are an existing customer and are interested in using Dynamic Flow Templates, please contact us or talk to your CSM.
Am I using Dynamic Flow Templates?
If your template ID starts with tmpl_
, then you are using the old Template and should use the Android SDK v1.
If your template ID starts with itmpl_
, then you are using the new Dynamic Flow Template and must use Android SDK v2.
I am an existing customer using Android SDK v1. Do I need to migrate?
You must use Android SDK v2 if you are using Dynamic Flow Templates. Inquiries created via Dynamic Flow Templates will not work properly with Android SDK v1.
Existing users who are not using Dynamic Flow Templates will not need to migrate to Android SDK v2, and Android SDK v1 will continue working for the immediate future. However, we encourage using the latest version whenever possible to take advantage of improvements and bug fixes.
If you have a hard reliance on removed features, but want/need to use Dynamic Flow Templates, please contact us or talk to your CSM for a migration path.
What do I need to do to migrate to Android SDK v2 API?
The following table lists breaking changes in the 2.x version of our SDK.
Updated namespace
The Android SDK v2 now has a new namespace. You can safely load v1 and v2 concurrently if you require a phased rollout to upgrade to Dynamic Flow.
Updating the SDKv2 namespace on Android
The package com.withpersona.sdk
has been renamed to com.withpersona.sdk2
so the easiest way to migrate to the new namespace is to do a project wide find and replace, changing all occurrences of com.withpersona.sdk
with com.withpersona.sdk2
.
Update dependency
Updated callbacks
Before
After
Supporting both v1 and v2 in parallel
Make sure the v1 instance is at least Android SDK v1.1.18.
Use the Persona.Inquiry2.Theme
and Persona.Inquiry1.Theme
and their corresponding fields to support the v1 themes (AppCompat-based) and v2 themes (Material-based).
Inquiry#start and Inquiry.onActivityResult are deprecated
The recommended way is to use the Activity Results API’s registerForActivityResult
method with the Inquiry.Contract()
object.
Update theming
Persona’s styles are now based on Material light as opposed to AppCompat’s day-night theme.