docs(forms): add form lifecycle events section to README#446
Merged
evan-masseau merged 2 commits intorel/4.4.0from May 5, 2026
Merged
docs(forms): add form lifecycle events section to README#446evan-masseau merged 2 commits intorel/4.4.0from
evan-masseau merged 2 commits intorel/4.4.0from
Conversation
Documents the FormLifecycleEvent API introduced in PR #434, including registration/unregistration, threading guarantee, and per-event semantics. Adds a feature matrix row and TOC entry. Example verified via :sample:assembleDebug. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Trim 'fires only when CTA has deep link' and 'does not fire on internal teardown' notes — these are translation-layer artifacts, not behavior worth highlighting in docs aimed at integrators.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
FormLifecycleEventAPI that shipped in #434 (feat(iaf) Android in-app form lifecycle hook support). This is the Android companion to klaviyo-swift-sdk #517.### Monitoring Form Lifecycle Eventssection after the In-App Forms session config / unregister content and before GeofencingForm Lifecycle Hooks | 4.4.0)FormCtaClickeddeep-link-only,FormDismisseduser-initiated only), and unregistration:sample:assembleDebug— the sample app already demonstrates the API inSampleApplication.ktChecklist
Notes
Planned for the 4.4.0 release. No code changes — pure documentation.
Android API quirks relative to iOS (see cross-platform notes in PR description of #517):
deepLinkUrlis typed asandroid.net.Uri(non-nullable), notString— callers need.toString()to pass it to string-based analytics SDKsFormLifecycleHandler.ktKDoc: main thread, callbacks fire after the SDK has already acted (presentation/dismissal/navigation already initiated)