docs: lifecycle events README section [4/4]#33
Open
choudlet wants to merge 2 commits into
Open
Conversation
choudlet
force-pushed
the
chrish/sc-38235/lifecycle-wiring-openurl
branch
from
382bcd4 to
4e7a426
Compare
Adds the user-facing documentation for the lifecycle events feature shipped by sc-38233 / sc-38234 / sc-38235. - Top-level Lifecycle Events section with the four events table, cold-launch sequencing rules, persistence semantics, and the rationale for cold-launch suppression on background-launched processes (silent push, JobScheduler, etc.) - Opt-in framing: trackLifecycleEvents defaults to false, sample of how to enable, note that openURL is a no-op when disabled - Deep-link wiring snippets for Activity.onCreate / onNewIntent and App Links via verified intent filters - Privacy guidance with a URL-sanitization sample (auth tokens, OTPs, magic-link params) - 'Why no auto-instrumentation' rationale (no manifest mutation, no ActivityLifecycleCallbacks proxy, host control) - TOC entry and openURL listed in the Analytics Interface API ref Refs: sc-38236
Slice 4 follow-ups from code review. - Activity entry-point snippet: drop the misleading intent.getStringExtra(Intent.EXTRA_REFERRER) suggestion. EXTRA_REFERRER is documented as a Uri, not a String, so the String overload always returns null. Use Activity.referrer?.host (the canonical API) instead. - Add an explicit imports block to the Activity snippet so it's copy-paste-runnable. - Soften intent.data!! in the privacy sample to a guarded let — a privacy-themed example shouldn't crash on a bare bang. - Add the android.net.Uri import to the sanitize() snippet for the same reason. Refs: sc-38236
choudlet
force-pushed
the
chrish/sc-38236/lifecycle-readme
branch
from
e6482b0 to
fb9ad90
Compare
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
1 participant
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.
Shortcut: sc-38236
Parent: sc-36799
iOS reference: sc-38231
Slice 4 of 4 — README documentation. No behavior change.
Summary
User-facing documentation for the lifecycle-events feature shipped by slices 1–3.
## Lifecycle Eventssection with the four-event table, cold-launch sequencing, persistence semantics, and rationale for cold-launch suppression on background-launched processes (silent push,JobScheduler, etc.).trackLifecycleEventsdefaults tofalse, sample of how to enable, note thatopenURL(...)is a no-op when disabled.Activity.onCreate/onNewIntentand App Links via verified intent filters.ActivityLifecycleCallbacksproxy, host control).openURLlisted in the Analytics Interface API ref.Stack
LifecycleEventTrackeralgorithm + testsopenURLpublic APITest plan
## Lifecycle Eventssection)./gradlew :metarouter-sdk:teststill passes (no behavior change)